Blame - docs/dyn/privateca_v1.projects.locations.caPools.certificateAuthorities.html - platform/external/python/google-api-python-client

<h1><a href="privateca_v1.html">Certificate Authority API</a> . <a href="privateca_v1.projects.html">projects</a> . <a href="privateca_v1.projects.locations.html">locations</a> . <a href="privateca_v1.projects.locations.caPools.html">caPools</a> . <a href="privateca_v1.projects.locations.caPools.certificateAuthorities.html">certificateAuthorities</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="privateca_v1.projects.locations.caPools.certificateAuthorities.certificateRevocationLists.html">certificateRevocationLists()</a></code>

79

</p>

80

<p class="firstline">Returns the certificateRevocationLists Resource.</p>

81

82

yoshi-code-bot

8759538

2021-06-05 00:38:05 -0700

[diff] [blame]

83

<code><a href="#activate">activate(name, body=None, x__xgafv=None)</a></code></p>

84

<p class="firstline">Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.</p>

85

yoshi-code-bot

31fbcc0

2021-06-02 00:52:03 -0700

[diff] [blame]

86

<code><a href="#close">close()</a></code></p>

87

<p class="firstline">Close httplib2 connections.</p>

yoshi-code-bot

8759538

2021-06-05 00:38:05 -0700

[diff] [blame]

88

89

<code><a href="#create">create(parent, body=None, certificateAuthorityId=None, requestId=None, x__xgafv=None)</a></code></p>

90

<p class="firstline">Create a new CertificateAuthority in a given Project and Location.</p>

91

92

<code><a href="#delete">delete(name, ignoreActiveCertificates=None, requestId=None, x__xgafv=None)</a></code></p>

93

<p class="firstline">Delete a CertificateAuthority.</p>

94

95

<code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>

96

<p class="firstline">Disable a CertificateAuthority.</p>

97

98

<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>

99

<p class="firstline">Enable a CertificateAuthority.</p>

100

101

<code><a href="#fetch">fetch(name, x__xgafv=None)</a></code></p>

102

<p class="firstline">Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.</p>

103

104

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

105

<p class="firstline">Returns a CertificateAuthority.</p>

106

107

<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

108

<p class="firstline">Lists CertificateAuthorities.</p>

109

110

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

111

<p class="firstline">Retrieves the next page of results.</p>

112

113

<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>

114

<p class="firstline">Update a CertificateAuthority.</p>

115

116

<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>

117

<p class="firstline">Undelete a CertificateAuthority that has been deleted.</p>

yoshi-code-bot

31fbcc0

2021-06-02 00:52:03 -0700

[diff] [blame]

118

<h3>Method Details</h3>

119

yoshi-code-bot

8759538

2021-06-05 00:38:05 -0700

[diff] [blame]

120

<code class="details" id="activate">activate(name, body=None, x__xgafv=None)</code>

121

<pre>Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

122

123

Args:

124

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

125

body: object, The request body.

126

The object takes the form of:

127

128

{ # Request message for CertificateAuthorityService.ActivateCertificateAuthority.

129

"pemCaCertificate": "A String", # Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.

130

"requestId": "A String", # Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

131

"subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.

132

"certificateAuthority": "A String", # Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

133

"pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.

134

"pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246.

"A String",

],

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

148

149

{ # This resource represents a long-running operation that is the result of a network API call.

150

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

151

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

152

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

153

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

154

{

155

"a_key": "", # Properties of the object. Contains field @type with type URL.

156

},

157

],

158

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

159

},

160

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

161

"a_key": "", # Properties of the object. Contains field @type with type URL.

162

},

163

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

164

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

165

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

yoshi-code-bot

2021-06-02 00:52:03 -0700

[diff] [blame]

171

<code class="details" id="close">close()</code>

172

<pre>Close httplib2 connections.</pre>

173

</div>

174

yoshi-code-bot

8759538

2021-06-05 00:38:05 -0700

[diff] [blame]

175

176

<code class="details" id="create">create(parent, body=None, certificateAuthorityId=None, requestId=None, x__xgafv=None)</code>

177

<pre>Create a new CertificateAuthority in a given Project and Location.

178

179

Args:

180

parent: string, Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`. (required)

181

body: object, The request body.

182

The object takes the form of:

183

184

{ # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

185

"accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

186

"caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.

187

"crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.

"A String",

],

},

"caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.

192

{ # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

193

"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

194

"A String",

195

],

196

"authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

197

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

198

},

199

"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.

200

"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.

201

},

202

"crlDistributionPoints": [ # Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

203

"A String",

204

],

205

"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.

206

"format": "A String", # Required. The format of the public key.

207

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

208

},

209

"subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime.

210

"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.

211

"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.

212

"notAfterTime": "A String", # The time at which the certificate expires.

213

"notBeforeTime": "A String", # The time at which the certificate becomes valid.

214

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization.

215

"commonName": "A String", # The "common name" of the subject.

216

"countryCode": "A String", # The country code of the subject.

217

"locality": "A String", # The locality or city of the subject.

218

"organization": "A String", # The organization of the subject.

219

"organizationalUnit": "A String", # The organizational_unit of the subject.

220

"postalCode": "A String", # The postal code of the subject.

221

"province": "A String", # The province, territory, or regional state of the subject.

222

"streetAddress": "A String", # The street address of the subject.

223

},

224

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields.

225

"customSans": [ # Contains additional subject alternative name values.

226

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

227

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

228

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

229

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

234

},

235

],

236

"dnsNames": [ # Contains only valid, fully-qualified host names.

237

"A String",

238

],

239

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

240

"A String",

241

],

242

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

243

"A String",

244

],

245

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

251

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

252

},

253

"x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate.

254

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

255

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

256

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

257

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

258

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

263

},

264

],

265

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

266

"A String",

267

],

268

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

269

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

270

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

271

},

272

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

273

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

274

"certSign": True or False, # The key may be used to sign certificates.

275

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

276

"crlSign": True or False, # The key may be used sign certificate revocation lists.

277

"dataEncipherment": True or False, # The key may be used to encipher data.

278

"decipherOnly": True or False, # The key may be used to decipher only.

279

"digitalSignature": True or False, # The key may be used for digital signatures.

280

"encipherOnly": True or False, # The key may be used to encipher only.

281

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

282

"keyEncipherment": True or False, # The key may be used to encipher other keys.

283

},

284

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

285

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

286

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

287

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

288

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

289

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

290

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

291

},

292

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

293

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

294

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

301

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

302

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

],

"config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

311

"publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

312

"format": "A String", # Required. The format of the public key.

313

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

314

},

315

"subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject.

316

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization.

317

"commonName": "A String", # The "common name" of the subject.

318

"countryCode": "A String", # The country code of the subject.

319

"locality": "A String", # The locality or city of the subject.

320

"organization": "A String", # The organization of the subject.

321

"organizationalUnit": "A String", # The organizational_unit of the subject.

322

"postalCode": "A String", # The postal code of the subject.

323

"province": "A String", # The province, territory, or regional state of the subject.

324

"streetAddress": "A String", # The street address of the subject.

325

},

326

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields.

327

"customSans": [ # Contains additional subject alternative name values.

328

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

329

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

330

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

331

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

336

},

337

],

338

"dnsNames": [ # Contains only valid, fully-qualified host names.

339

"A String",

340

],

341

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

342

"A String",

343

],

344

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

345

"A String",

346

],

347

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated.

353

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

354

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

355

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

356

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

357

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

362

},

363

],

364

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

365

"A String",

366

],

367

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

368

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

369

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

370

},

371

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

372

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

373

"certSign": True or False, # The key may be used to sign certificates.

374

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

375

"crlSign": True or False, # The key may be used sign certificate revocation lists.

376

"dataEncipherment": True or False, # The key may be used to encipher data.

377

"decipherOnly": True or False, # The key may be used to decipher only.

378

"digitalSignature": True or False, # The key may be used for digital signatures.

379

"encipherOnly": True or False, # The key may be used to encipher only.

380

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

381

"keyEncipherment": True or False, # The key may be used to encipher other keys.

382

},

383

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

384

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

385

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

386

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

387

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

388

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

389

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

390

},

391

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

392

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

393

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

400

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

401

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

"createTime": "A String", # Output only. The time at which this CertificateAuthority was created.

409

"deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.

410

"expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.

411

"gcsBucket": "A String", # Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created.

412

"keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.

413

"algorithm": "A String", # The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.

414

"cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.

415

},

416

"labels": { # Optional. Labels with user-defined metadata.

417

"a_key": "A String",

418

},

419

"lifetime": "A String", # Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.

420

"name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

421

"pemCaCertificates": [ # Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

422

"A String",

423

],

424

"state": "A String", # Output only. The State for this CertificateAuthority.

425

"subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

426

"certificateAuthority": "A String", # Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

427

"pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.

428

"pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246.

"A String",

],

},

},

"tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

434

"type": "A String", # Required. Immutable. The Type of this CertificateAuthority.

435

"updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated.

436

}

437

438

certificateAuthorityId: string, Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`

439

requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

440

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

447

448

{ # This resource represents a long-running operation that is the result of a network API call.

449

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

450

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

451

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

452

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

453

{

454

"a_key": "", # Properties of the object. Contains field @type with type URL.

455

},

456

],

457

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

458

},

459

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

460

"a_key": "", # Properties of the object. Contains field @type with type URL.

461

},

462

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

463

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

464

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, ignoreActiveCertificates=None, requestId=None, x__xgafv=None)</code>

471

<pre>Delete a CertificateAuthority.

472

473

Args:

474

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

475

ignoreActiveCertificates: boolean, Optional. This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs.

476

requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

477

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

484

485

{ # This resource represents a long-running operation that is the result of a network API call.

486

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

487

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

488

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

489

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

490

{

491

"a_key": "", # Properties of the object. Contains field @type with type URL.

492

},

493

],

494

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

495

},

496

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

497

"a_key": "", # Properties of the object. Contains field @type with type URL.

498

},

499

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

500

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

501

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>

508

<pre>Disable a CertificateAuthority.

509

510

Args:

511

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

512

body: object, The request body.

513

The object takes the form of:

514

515

{ # Request message for CertificateAuthorityService.DisableCertificateAuthority.

516

"requestId": "A String", # Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

517

}

518

519

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

526

527

{ # This resource represents a long-running operation that is the result of a network API call.

528

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

529

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

530

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

531

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

532

{

533

"a_key": "", # Properties of the object. Contains field @type with type URL.

534

},

535

],

536

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

537

},

538

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

539

"a_key": "", # Properties of the object. Contains field @type with type URL.

540

},

541

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

542

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

543

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>

550

<pre>Enable a CertificateAuthority.

551

552

Args:

553

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

554

body: object, The request body.

555

The object takes the form of:

556

557

{ # Request message for CertificateAuthorityService.EnableCertificateAuthority.

558

"requestId": "A String", # Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

559

}

560

561

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

568

569

{ # This resource represents a long-running operation that is the result of a network API call.

570

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

571

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

572

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

573

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

574

{

575

"a_key": "", # Properties of the object. Contains field @type with type URL.

576

},

577

],

578

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

579

},

580

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

581

"a_key": "", # Properties of the object. Contains field @type with type URL.

582

},

583

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

584

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

585

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="fetch">fetch(name, x__xgafv=None)</code>

592

<pre>Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

593

594

Args:

595

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

596

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

603

604

{ # Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

605

"pemCsr": "A String", # Output only. The PEM-encoded signed certificate signing request (CSR).

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

611

<pre>Returns a CertificateAuthority.

612

613

Args:

614

name: string, Required. The name of the CertificateAuthority to get. (required)

615

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

622

623

{ # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

624

"accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

625

"caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.

626

"crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.

"A String",

],

},

"caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.

631

{ # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

632

"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

633

"A String",

634

],

635

"authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

636

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

637

},

638

"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.

639

"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.

640

},

641

"crlDistributionPoints": [ # Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

642

"A String",

643

],

644

"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.

645

"format": "A String", # Required. The format of the public key.

646

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

647

},

648

"subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime.

649

"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.

650

"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.

651

"notAfterTime": "A String", # The time at which the certificate expires.

652

"notBeforeTime": "A String", # The time at which the certificate becomes valid.

653

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization.

654

"commonName": "A String", # The "common name" of the subject.

655

"countryCode": "A String", # The country code of the subject.

656

"locality": "A String", # The locality or city of the subject.

657

"organization": "A String", # The organization of the subject.

658

"organizationalUnit": "A String", # The organizational_unit of the subject.

659

"postalCode": "A String", # The postal code of the subject.

660

"province": "A String", # The province, territory, or regional state of the subject.

661

"streetAddress": "A String", # The street address of the subject.

662

},

663

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields.

664

"customSans": [ # Contains additional subject alternative name values.

665

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

666

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

667

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

668

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

673

},

674

],

675

"dnsNames": [ # Contains only valid, fully-qualified host names.

676

"A String",

677

],

678

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

679

"A String",

680

],

681

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

682

"A String",

683

],

684

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

690

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

691

},

692

"x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate.

693

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

694

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

695

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

696

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

697

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

702

},

703

],

704

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

705

"A String",

706

],

707

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

708

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

709

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

710

},

711

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

712

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

713

"certSign": True or False, # The key may be used to sign certificates.

714

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

715

"crlSign": True or False, # The key may be used sign certificate revocation lists.

716

"dataEncipherment": True or False, # The key may be used to encipher data.

717

"decipherOnly": True or False, # The key may be used to decipher only.

718

"digitalSignature": True or False, # The key may be used for digital signatures.

719

"encipherOnly": True or False, # The key may be used to encipher only.

720

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

721

"keyEncipherment": True or False, # The key may be used to encipher other keys.

722

},

723

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

724

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

725

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

726

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

727

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

728

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

729

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

730

},

731

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

732

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

733

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

740

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

741

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

],

"config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

750

"publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

751

"format": "A String", # Required. The format of the public key.

752

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

753

},

754

"subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject.

755

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization.

756

"commonName": "A String", # The "common name" of the subject.

757

"countryCode": "A String", # The country code of the subject.

758

"locality": "A String", # The locality or city of the subject.

759

"organization": "A String", # The organization of the subject.

760

"organizationalUnit": "A String", # The organizational_unit of the subject.

761

"postalCode": "A String", # The postal code of the subject.

762

"province": "A String", # The province, territory, or regional state of the subject.

763

"streetAddress": "A String", # The street address of the subject.

764

},

765

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields.

766

"customSans": [ # Contains additional subject alternative name values.

767

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

768

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

769

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

770

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

775

},

776

],

777

"dnsNames": [ # Contains only valid, fully-qualified host names.

778

"A String",

779

],

780

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

781

"A String",

782

],

783

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

784

"A String",

785

],

786

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated.

792

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

793

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

794

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

795

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

796

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

801

},

802

],

803

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

804

"A String",

805

],

806

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

807

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

808

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

809

},

810

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

811

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

812

"certSign": True or False, # The key may be used to sign certificates.

813

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

814

"crlSign": True or False, # The key may be used sign certificate revocation lists.

815

"dataEncipherment": True or False, # The key may be used to encipher data.

816

"decipherOnly": True or False, # The key may be used to decipher only.

817

"digitalSignature": True or False, # The key may be used for digital signatures.

818

"encipherOnly": True or False, # The key may be used to encipher only.

819

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

820

"keyEncipherment": True or False, # The key may be used to encipher other keys.

821

},

822

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

823

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

824

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

825

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

826

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

827

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

828

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

829

},

830

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

831

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

832

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

839

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

840

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

"createTime": "A String", # Output only. The time at which this CertificateAuthority was created.

848

"deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.

849

"expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.

850

"gcsBucket": "A String", # Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created.

851

"keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.

852

"algorithm": "A String", # The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.

853

"cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.

854

},

855

"labels": { # Optional. Labels with user-defined metadata.

856

"a_key": "A String",

857

},

858

"lifetime": "A String", # Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.

859

"name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

860

"pemCaCertificates": [ # Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

861

"A String",

862

],

863

"state": "A String", # Output only. The State for this CertificateAuthority.

864

"subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

865

"certificateAuthority": "A String", # Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

866

"pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.

867

"pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246.

"A String",

],

},

},

"tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

873

"type": "A String", # Required. Immutable. The Type of this CertificateAuthority.

874

"updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated.

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

880

<pre>Lists CertificateAuthorities.

881

882

Args:

883

parent: string, Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`. (required)

884

filter: string, Optional. Only include resources that match the filter in the response.

885

orderBy: string, Optional. Specify how the results should be sorted.

886

pageSize: integer, Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

887

pageToken: string, Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.

888

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

895

896

{ # Response message for CertificateAuthorityService.ListCertificateAuthorities.

897

"certificateAuthorities": [ # The list of CertificateAuthorities.

898

{ # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

899

"accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

900

"caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.

901

"crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.

"A String",

],

},

"caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.

906

{ # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

907

"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

908

"A String",

909

],

910

"authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

911

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

912

},

913

"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.

914

"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.

915

},

916

"crlDistributionPoints": [ # Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

917

"A String",

918

],

919

"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.

920

"format": "A String", # Required. The format of the public key.

921

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

922

},

923

"subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime.

924

"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.

925

"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.

926

"notAfterTime": "A String", # The time at which the certificate expires.

927

"notBeforeTime": "A String", # The time at which the certificate becomes valid.

928

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization.

929

"commonName": "A String", # The "common name" of the subject.

930

"countryCode": "A String", # The country code of the subject.

931

"locality": "A String", # The locality or city of the subject.

932

"organization": "A String", # The organization of the subject.

933

"organizationalUnit": "A String", # The organizational_unit of the subject.

934

"postalCode": "A String", # The postal code of the subject.

935

"province": "A String", # The province, territory, or regional state of the subject.

936

"streetAddress": "A String", # The street address of the subject.

937

},

938

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields.

939

"customSans": [ # Contains additional subject alternative name values.

940

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

941

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

942

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

943

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

948

},

949

],

950

"dnsNames": [ # Contains only valid, fully-qualified host names.

951

"A String",

952

],

953

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

954

"A String",

955

],

956

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

957

"A String",

958

],

959

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

965

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

966

},

967

"x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate.

968

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

969

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

970

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

971

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

972

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

977

},

978

],

979

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

980

"A String",

981

],

982

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

983

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

984

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

985

},

986

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

987

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

988

"certSign": True or False, # The key may be used to sign certificates.

989

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

990

"crlSign": True or False, # The key may be used sign certificate revocation lists.

991

"dataEncipherment": True or False, # The key may be used to encipher data.

992

"decipherOnly": True or False, # The key may be used to decipher only.

993

"digitalSignature": True or False, # The key may be used for digital signatures.

994

"encipherOnly": True or False, # The key may be used to encipher only.

995

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

996

"keyEncipherment": True or False, # The key may be used to encipher other keys.

997

},

998

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

999

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

1000

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

1001

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

1002

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

1003

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

1004

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

1005

},

1006

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

1007

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1008

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

1015

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1016

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

],

"config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

1025

"publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

1026

"format": "A String", # Required. The format of the public key.

1027

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

1028

},

1029

"subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject.

1030

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization.

1031

"commonName": "A String", # The "common name" of the subject.

1032

"countryCode": "A String", # The country code of the subject.

1033

"locality": "A String", # The locality or city of the subject.

1034

"organization": "A String", # The organization of the subject.

1035

"organizationalUnit": "A String", # The organizational_unit of the subject.

1036

"postalCode": "A String", # The postal code of the subject.

1037

"province": "A String", # The province, territory, or regional state of the subject.

1038

"streetAddress": "A String", # The street address of the subject.

1039

},

1040

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields.

1041

"customSans": [ # Contains additional subject alternative name values.

1042

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1043

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1044

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1045

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1050

},

1051

],

1052

"dnsNames": [ # Contains only valid, fully-qualified host names.

1053

"A String",

1054

],

1055

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

1056

"A String",

1057

],

1058

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

1059

"A String",

1060

],

1061

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated.

1067

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

1068

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1069

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1070

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1071

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1076

},

1077

],

1078

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

1079

"A String",

1080

],

1081

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

1082

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

1083

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

1084

},

1085

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

1086

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

1087

"certSign": True or False, # The key may be used to sign certificates.

1088

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

1089

"crlSign": True or False, # The key may be used sign certificate revocation lists.

1090

"dataEncipherment": True or False, # The key may be used to encipher data.

1091

"decipherOnly": True or False, # The key may be used to decipher only.

1092

"digitalSignature": True or False, # The key may be used for digital signatures.

1093

"encipherOnly": True or False, # The key may be used to encipher only.

1094

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

1095

"keyEncipherment": True or False, # The key may be used to encipher other keys.

1096

},

1097

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

1098

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

1099

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

1100

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

1101

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

1102

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

1103

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

1104

},

1105

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

1106

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1107

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

1114

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1115

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

"createTime": "A String", # Output only. The time at which this CertificateAuthority was created.

1123

"deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.

1124

"expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.

1125

"gcsBucket": "A String", # Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created.

1126

"keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.

1127

"algorithm": "A String", # The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.

1128

"cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.

1129

},

1130

"labels": { # Optional. Labels with user-defined metadata.

1131

"a_key": "A String",

1132

},

1133

"lifetime": "A String", # Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.

1134

"name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

1135

"pemCaCertificates": [ # Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

1136

"A String",

1137

],

1138

"state": "A String", # Output only. The State for this CertificateAuthority.

1139

"subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

1140

"certificateAuthority": "A String", # Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

1141

"pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.

1142

"pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246.

"A String",

],

},

},

"tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

1148

"type": "A String", # Required. Immutable. The Type of this CertificateAuthority.

1149

"updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated.

1150

},

1151

],

1152

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results.

1153

"unreachable": [ # A list of locations (e.g. "us-west1") that could not be reached.

"A String",

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1161

<pre>Retrieves the next page of results.

1162

1163

Args:

1164

previous_request: The request for the previous page. (required)

1165

previous_response: The response from the request for the previous page. (required)

1166

1167

Returns:

1168

A request object that you can call 'execute()' on to request the next

1169

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>

1175

<pre>Update a CertificateAuthority.

1176

1177

Args:

1178

name: string, Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

1179

body: object, The request body.

1180

The object takes the form of:

1181

1182

{ # A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

1183

"accessUrls": { # URLs where a CertificateAuthority will publish content. # Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.

1184

"caCertificateAccessUrl": "A String", # The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.

1185

"crlAccessUrls": [ # The URLs where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.

"A String",

],

},

"caCertificateDescriptions": [ # Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.

1190

{ # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

1191

"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.

1192

"A String",

1193

],

1194

"authorityKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1

1195

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

1196

},

1197

"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.

1198

"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.

1199

},

1200

"crlDistributionPoints": [ # Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13

1201

"A String",

1202

],

1203

"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.

1204

"format": "A String", # Required. The format of the public key.

1205

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

1206

},

1207

"subjectDescription": { # These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime. # Describes some of the values in a certificate that are related to the subject and lifetime.

1208

"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.

1209

"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.

1210

"notAfterTime": "A String", # The time at which the certificate expires.

1211

"notBeforeTime": "A String", # The time at which the certificate becomes valid.

1212

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Contains distinguished name fields such as the common name, location and / organization.

1213

"commonName": "A String", # The "common name" of the subject.

1214

"countryCode": "A String", # The country code of the subject.

1215

"locality": "A String", # The locality or city of the subject.

1216

"organization": "A String", # The organization of the subject.

1217

"organizationalUnit": "A String", # The organizational_unit of the subject.

1218

"postalCode": "A String", # The postal code of the subject.

1219

"province": "A String", # The province, territory, or regional state of the subject.

1220

"streetAddress": "A String", # The street address of the subject.

1221

},

1222

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # The subject alternative name fields.

1223

"customSans": [ # Contains additional subject alternative name values.

1224

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1225

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1226

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1227

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1232

},

1233

],

1234

"dnsNames": [ # Contains only valid, fully-qualified host names.

1235

"A String",

1236

],

1237

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

1238

"A String",

1239

],

1240

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

1241

"A String",

1242

],

1243

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.

1249

"keyId": "A String", # Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.

1250

},

1251

"x509Description": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Describes some of the technical X.509 fields in a certificate.

1252

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

1253

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1254

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1255

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1256

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1261

},

1262

],

1263

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

1264

"A String",

1265

],

1266

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

1267

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

1268

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

1269

},

1270

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

1271

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

1272

"certSign": True or False, # The key may be used to sign certificates.

1273

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

1274

"crlSign": True or False, # The key may be used sign certificate revocation lists.

1275

"dataEncipherment": True or False, # The key may be used to encipher data.

1276

"decipherOnly": True or False, # The key may be used to decipher only.

1277

"digitalSignature": True or False, # The key may be used for digital signatures.

1278

"encipherOnly": True or False, # The key may be used to encipher only.

1279

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

1280

"keyEncipherment": True or False, # The key may be used to encipher other keys.

1281

},

1282

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

1283

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

1284

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

1285

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

1286

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

1287

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

1288

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

1289

},

1290

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

1291

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1292

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

1299

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1300

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

],

"config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.

1309

"publicKey": { # A PublicKey describes a public key. # Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR.

1310

"format": "A String", # Required. The format of the public key.

1311

"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.

1312

},

1313

"subjectConfig": { # These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate. # Required. Specifies some of the values in a certificate that are related to the subject.

1314

"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Required. Contains distinguished name fields such as the common name, location and organization.

1315

"commonName": "A String", # The "common name" of the subject.

1316

"countryCode": "A String", # The country code of the subject.

1317

"locality": "A String", # The locality or city of the subject.

1318

"organization": "A String", # The organization of the subject.

1319

"organizationalUnit": "A String", # The organizational_unit of the subject.

1320

"postalCode": "A String", # The postal code of the subject.

1321

"province": "A String", # The province, territory, or regional state of the subject.

1322

"streetAddress": "A String", # The street address of the subject.

1323

},

1324

"subjectAltName": { # SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name). # Optional. The subject alternative name fields.

1325

"customSans": [ # Contains additional subject alternative name values.

1326

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1327

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1328

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1329

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1334

},

1335

],

1336

"dnsNames": [ # Contains only valid, fully-qualified host names.

1337

"A String",

1338

],

1339

"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.

1340

"A String",

1341

],

1342

"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.

1343

"A String",

1344

],

1345

"uris": [ # Contains only valid RFC 3986 URIs.

"A String",

],

},

},

"x509Config": { # An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. # Required. Describes how some of the technical X.509 fields in a certificate should be populated.

1351

"additionalExtensions": [ # Optional. Describes custom X.509 extensions.

1352

{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

1353

"critical": True or False, # Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).

1354

"objectId": { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. # Required. The OID for this X.509 extension.

1355

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

"value": "A String", # Required. The value of this X.509 extension.

1360

},

1361

],

1362

"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

1363

"A String",

1364

],

1365

"caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

1366

"isCa": True or False, # Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

1367

"maxIssuerPathLength": 42, # Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

1368

},

1369

"keyUsage": { # A KeyUsage describes key usage values that may appear in an X.509 certificate. # Optional. Indicates the intended use for keys that correspond to a certificate.

1370

"baseKeyUsage": { # KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3. # Describes high-level ways in which a key may be used.

1371

"certSign": True or False, # The key may be used to sign certificates.

1372

"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

1373

"crlSign": True or False, # The key may be used sign certificate revocation lists.

1374

"dataEncipherment": True or False, # The key may be used to encipher data.

1375

"decipherOnly": True or False, # The key may be used to decipher only.

1376

"digitalSignature": True or False, # The key may be used for digital signatures.

1377

"encipherOnly": True or False, # The key may be used to encipher only.

1378

"keyAgreement": True or False, # The key may be used in a key agreement protocol.

1379

"keyEncipherment": True or False, # The key may be used to encipher other keys.

1380

},

1381

"extendedKeyUsage": { # KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value. # Detailed scenarios in which a key may be used.

1382

"clientAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.

1383

"codeSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

1384

"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

1385

"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

1386

"serverAuth": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.

1387

"timeStamping": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".

1388

},

1389

"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

1390

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1391

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

1398

{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

1399

"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.

42,

],

},

],

},

},

"createTime": "A String", # Output only. The time at which this CertificateAuthority was created.

1407

"deleteTime": "A String", # Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state.

1408

"expireTime": "A String", # Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state.

1409

"gcsBucket": "A String", # Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created.

1410

"keySpec": { # A Cloud KMS key configuration that a CertificateAuthority will use. # Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.

1411

"algorithm": "A String", # The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.

1412

"cloudKmsKeyVersion": "A String", # The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.

1413

},

1414

"labels": { # Optional. Labels with user-defined metadata.

1415

"a_key": "A String",

1416

},

1417

"lifetime": "A String", # Required. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate.

1418

"name": "A String", # Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

1419

"pemCaCertificates": [ # Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.

1420

"A String",

1421

],

1422

"state": "A String", # Output only. The State for this CertificateAuthority.

1423

"subordinateConfig": { # Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. # Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate.

1424

"certificateAuthority": "A String", # Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

1425

"pemIssuerChain": { # This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons. # Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself.

1426

"pemCertificates": [ # Required. Expected to be in leaf-to-root order according to RFC 5246.

"A String",

],

},

},

"tier": "A String", # Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority.

1432

"type": "A String", # Required. Immutable. The Type of this CertificateAuthority.

1433

"updateTime": "A String", # Output only. The time at which this CertificateAuthority was last updated.

1434

}

1435

1436

requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1437

updateMask: string, Required. A list of fields to be updated in this request.

1438

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1445

1446

{ # This resource represents a long-running operation that is the result of a network API call.

1447

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1448

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1449

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1450

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1451

{

1452

"a_key": "", # Properties of the object. Contains field @type with type URL.

1453

},

1454

],

1455

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1456

},

1457

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1458

"a_key": "", # Properties of the object. Contains field @type with type URL.

1459

},

1460

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

1461

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1462

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>

1469

<pre>Undelete a CertificateAuthority that has been deleted.

1470

1471

Args:

1472

name: string, Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. (required)

1473

body: object, The request body.

1474

The object takes the form of:

1475

1476

{ # Request message for CertificateAuthorityService.UndeleteCertificateAuthority.

1477

"requestId": "A String", # Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1478

}

1479

1480

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1487

1488

{ # This resource represents a long-running operation that is the result of a network API call.

1489

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1490

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1491

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1492

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1493

{

1494

"a_key": "", # Properties of the object. Contains field @type with type URL.

1495

},

1496

],

1497

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1498

},

1499

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1500

"a_key": "", # Properties of the object. Contains field @type with type URL.

1501

},

1502

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

1503

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1504

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

yoshi-code-bot

2021-06-02 00:52:03 -0700

[diff] [blame]

1509

</body></html>