1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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.certificates.html">certificates</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, certificateId=None, issuingCertificateAuthorityId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Create a new Certificate in a given Project, Location from a particular CaPool.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns a Certificate.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists Certificates.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Update a Certificate. Currently, the only field you can update is the labels field.</p> 95<p class="toc_element"> 96 <code><a href="#revoke">revoke(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Revoke a Certificate.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, certificateId=None, issuingCertificateAuthorityId=None, requestId=None, validateOnly=None, x__xgafv=None)</code> 106 <pre>Create a new Certificate in a given Project, Location from a particular CaPool. 107 108Args: 109 parent: string, Required. The resource name of the CaPool associated with the Certificate, in the format `projects/*/locations/*/caPools/*`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 114 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 115 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 116 "A String", 117 ], 118 "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 119 "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. 120 }, 121 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 122 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 123 }, 124 "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 125 "A String", 126 ], 127 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 128 "format": "A String", # Required. The format of the public key. 129 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 130 }, 131 "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. 132 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 133 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 134 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 135 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 136 "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. 137 "commonName": "A String", # The "common name" of the subject. 138 "countryCode": "A String", # The country code of the subject. 139 "locality": "A String", # The locality or city of the subject. 140 "organization": "A String", # The organization of the subject. 141 "organizationalUnit": "A String", # The organizational_unit of the subject. 142 "postalCode": "A String", # The postal code of the subject. 143 "province": "A String", # The province, territory, or regional state of the subject. 144 "streetAddress": "A String", # The street address of the subject. 145 }, 146 "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. 147 "customSans": [ # Contains additional subject alternative name values. 148 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 149 "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). 150 "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. 151 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 152 42, 153 ], 154 }, 155 "value": "A String", # Required. The value of this X.509 extension. 156 }, 157 ], 158 "dnsNames": [ # Contains only valid, fully-qualified host names. 159 "A String", 160 ], 161 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 162 "A String", 163 ], 164 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 165 "A String", 166 ], 167 "uris": [ # Contains only valid RFC 3986 URIs. 168 "A String", 169 ], 170 }, 171 }, 172 "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. 173 "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. 174 }, 175 "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. 176 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 177 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 178 "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). 179 "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. 180 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 181 42, 182 ], 183 }, 184 "value": "A String", # Required. The value of this X.509 extension. 185 }, 186 ], 187 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 188 "A String", 189 ], 190 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 191 "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. 192 "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. 193 }, 194 "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. 195 "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. 196 "certSign": True or False, # The key may be used to sign certificates. 197 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 198 "crlSign": True or False, # The key may be used sign certificate revocation lists. 199 "dataEncipherment": True or False, # The key may be used to encipher data. 200 "decipherOnly": True or False, # The key may be used to decipher only. 201 "digitalSignature": True or False, # The key may be used for digital signatures. 202 "encipherOnly": True or False, # The key may be used to encipher only. 203 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 204 "keyEncipherment": True or False, # The key may be used to encipher other keys. 205 }, 206 "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. 207 "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. 208 "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". 209 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 210 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 211 "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. 212 "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". 213 }, 214 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 215 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 216 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 217 42, 218 ], 219 }, 220 ], 221 }, 222 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 223 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 224 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 225 42, 226 ], 227 }, 228 ], 229 }, 230 }, 231 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 232 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 233 "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. 234 "format": "A String", # Required. The format of the public key. 235 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 236 }, 237 "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. 238 "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. 239 "commonName": "A String", # The "common name" of the subject. 240 "countryCode": "A String", # The country code of the subject. 241 "locality": "A String", # The locality or city of the subject. 242 "organization": "A String", # The organization of the subject. 243 "organizationalUnit": "A String", # The organizational_unit of the subject. 244 "postalCode": "A String", # The postal code of the subject. 245 "province": "A String", # The province, territory, or regional state of the subject. 246 "streetAddress": "A String", # The street address of the subject. 247 }, 248 "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. 249 "customSans": [ # Contains additional subject alternative name values. 250 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 251 "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). 252 "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. 253 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 254 42, 255 ], 256 }, 257 "value": "A String", # Required. The value of this X.509 extension. 258 }, 259 ], 260 "dnsNames": [ # Contains only valid, fully-qualified host names. 261 "A String", 262 ], 263 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 264 "A String", 265 ], 266 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 267 "A String", 268 ], 269 "uris": [ # Contains only valid RFC 3986 URIs. 270 "A String", 271 ], 272 }, 273 }, 274 "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. 275 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 276 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 277 "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). 278 "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. 279 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 280 42, 281 ], 282 }, 283 "value": "A String", # Required. The value of this X.509 extension. 284 }, 285 ], 286 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 287 "A String", 288 ], 289 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 290 "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. 291 "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. 292 }, 293 "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. 294 "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. 295 "certSign": True or False, # The key may be used to sign certificates. 296 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 297 "crlSign": True or False, # The key may be used sign certificate revocation lists. 298 "dataEncipherment": True or False, # The key may be used to encipher data. 299 "decipherOnly": True or False, # The key may be used to decipher only. 300 "digitalSignature": True or False, # The key may be used for digital signatures. 301 "encipherOnly": True or False, # The key may be used to encipher only. 302 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 303 "keyEncipherment": True or False, # The key may be used to encipher other keys. 304 }, 305 "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. 306 "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. 307 "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". 308 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 309 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 310 "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. 311 "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". 312 }, 313 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 314 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 315 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 316 42, 317 ], 318 }, 319 ], 320 }, 321 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 322 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 323 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 324 42, 325 ], 326 }, 327 ], 328 }, 329 }, 330 "createTime": "A String", # Output only. The time at which this Certificate was created. 331 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 332 "labels": { # Optional. Labels with user-defined metadata. 333 "a_key": "A String", 334 }, 335 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 336 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 337 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 338 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 339 "A String", 340 ], 341 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 342 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 343 "revocationState": "A String", # Indicates why a Certificate was revoked. 344 "revocationTime": "A String", # The time at which this Certificate was revoked. 345 }, 346 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 347 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 348} 349 350 certificateId: string, Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is optional and its value is ignored otherwise. 351 issuingCertificateAuthorityId: string, Optional. The resource ID of the CertificateAuthority that should issue the certificate. This optional field will ignore the load-balancing scheme of the Pool and directly issue the certificate from the CA with the specified ID, contained in the same CaPool referenced by `parent`. Per-CA quota rules apply. If left empty, a CertificateAuthority will be chosen from the CaPool by the service. For example, to issue a Certificate from a Certificate Authority with resource name "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca", you can set the parent to "projects/my-project/locations/us-central1/caPools/my-pool" and the issuing_certificate_authority_id to "my-ca". 352 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 the 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). 353 validateOnly: boolean, Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field. 354 x__xgafv: string, V1 error format. 355 Allowed values 356 1 - v1 error format 357 2 - v2 error format 358 359Returns: 360 An object of the form: 361 362 { # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 363 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 364 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 365 "A String", 366 ], 367 "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 368 "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. 369 }, 370 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 371 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 372 }, 373 "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 374 "A String", 375 ], 376 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 377 "format": "A String", # Required. The format of the public key. 378 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 379 }, 380 "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. 381 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 382 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 383 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 384 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 385 "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. 386 "commonName": "A String", # The "common name" of the subject. 387 "countryCode": "A String", # The country code of the subject. 388 "locality": "A String", # The locality or city of the subject. 389 "organization": "A String", # The organization of the subject. 390 "organizationalUnit": "A String", # The organizational_unit of the subject. 391 "postalCode": "A String", # The postal code of the subject. 392 "province": "A String", # The province, territory, or regional state of the subject. 393 "streetAddress": "A String", # The street address of the subject. 394 }, 395 "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. 396 "customSans": [ # Contains additional subject alternative name values. 397 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 398 "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). 399 "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. 400 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 401 42, 402 ], 403 }, 404 "value": "A String", # Required. The value of this X.509 extension. 405 }, 406 ], 407 "dnsNames": [ # Contains only valid, fully-qualified host names. 408 "A String", 409 ], 410 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 411 "A String", 412 ], 413 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 414 "A String", 415 ], 416 "uris": [ # Contains only valid RFC 3986 URIs. 417 "A String", 418 ], 419 }, 420 }, 421 "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. 422 "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. 423 }, 424 "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. 425 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 426 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 427 "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). 428 "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. 429 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 430 42, 431 ], 432 }, 433 "value": "A String", # Required. The value of this X.509 extension. 434 }, 435 ], 436 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 437 "A String", 438 ], 439 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 440 "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. 441 "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. 442 }, 443 "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. 444 "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. 445 "certSign": True or False, # The key may be used to sign certificates. 446 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 447 "crlSign": True or False, # The key may be used sign certificate revocation lists. 448 "dataEncipherment": True or False, # The key may be used to encipher data. 449 "decipherOnly": True or False, # The key may be used to decipher only. 450 "digitalSignature": True or False, # The key may be used for digital signatures. 451 "encipherOnly": True or False, # The key may be used to encipher only. 452 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 453 "keyEncipherment": True or False, # The key may be used to encipher other keys. 454 }, 455 "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. 456 "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. 457 "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". 458 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 459 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 460 "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. 461 "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". 462 }, 463 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 464 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 465 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 466 42, 467 ], 468 }, 469 ], 470 }, 471 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 472 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 473 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 474 42, 475 ], 476 }, 477 ], 478 }, 479 }, 480 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 481 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 482 "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. 483 "format": "A String", # Required. The format of the public key. 484 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 485 }, 486 "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. 487 "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. 488 "commonName": "A String", # The "common name" of the subject. 489 "countryCode": "A String", # The country code of the subject. 490 "locality": "A String", # The locality or city of the subject. 491 "organization": "A String", # The organization of the subject. 492 "organizationalUnit": "A String", # The organizational_unit of the subject. 493 "postalCode": "A String", # The postal code of the subject. 494 "province": "A String", # The province, territory, or regional state of the subject. 495 "streetAddress": "A String", # The street address of the subject. 496 }, 497 "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. 498 "customSans": [ # Contains additional subject alternative name values. 499 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 500 "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). 501 "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. 502 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 503 42, 504 ], 505 }, 506 "value": "A String", # Required. The value of this X.509 extension. 507 }, 508 ], 509 "dnsNames": [ # Contains only valid, fully-qualified host names. 510 "A String", 511 ], 512 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 513 "A String", 514 ], 515 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 516 "A String", 517 ], 518 "uris": [ # Contains only valid RFC 3986 URIs. 519 "A String", 520 ], 521 }, 522 }, 523 "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. 524 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 525 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 526 "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). 527 "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. 528 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 529 42, 530 ], 531 }, 532 "value": "A String", # Required. The value of this X.509 extension. 533 }, 534 ], 535 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 536 "A String", 537 ], 538 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 539 "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. 540 "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. 541 }, 542 "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. 543 "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. 544 "certSign": True or False, # The key may be used to sign certificates. 545 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 546 "crlSign": True or False, # The key may be used sign certificate revocation lists. 547 "dataEncipherment": True or False, # The key may be used to encipher data. 548 "decipherOnly": True or False, # The key may be used to decipher only. 549 "digitalSignature": True or False, # The key may be used for digital signatures. 550 "encipherOnly": True or False, # The key may be used to encipher only. 551 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 552 "keyEncipherment": True or False, # The key may be used to encipher other keys. 553 }, 554 "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. 555 "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. 556 "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". 557 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 558 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 559 "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. 560 "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". 561 }, 562 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 563 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 564 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 565 42, 566 ], 567 }, 568 ], 569 }, 570 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 571 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 572 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 573 42, 574 ], 575 }, 576 ], 577 }, 578 }, 579 "createTime": "A String", # Output only. The time at which this Certificate was created. 580 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 581 "labels": { # Optional. Labels with user-defined metadata. 582 "a_key": "A String", 583 }, 584 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 585 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 586 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 587 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 588 "A String", 589 ], 590 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 591 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 592 "revocationState": "A String", # Indicates why a Certificate was revoked. 593 "revocationTime": "A String", # The time at which this Certificate was revoked. 594 }, 595 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 596 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 597}</pre> 598</div> 599 600<div class="method"> 601 <code class="details" id="get">get(name, x__xgafv=None)</code> 602 <pre>Returns a Certificate. 603 604Args: 605 name: string, Required. The name of the Certificate to get. (required) 606 x__xgafv: string, V1 error format. 607 Allowed values 608 1 - v1 error format 609 2 - v2 error format 610 611Returns: 612 An object of the form: 613 614 { # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 615 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 616 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 617 "A String", 618 ], 619 "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 620 "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. 621 }, 622 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 623 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 624 }, 625 "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 626 "A String", 627 ], 628 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 629 "format": "A String", # Required. The format of the public key. 630 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 631 }, 632 "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. 633 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 634 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 635 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 636 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 637 "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. 638 "commonName": "A String", # The "common name" of the subject. 639 "countryCode": "A String", # The country code of the subject. 640 "locality": "A String", # The locality or city of the subject. 641 "organization": "A String", # The organization of the subject. 642 "organizationalUnit": "A String", # The organizational_unit of the subject. 643 "postalCode": "A String", # The postal code of the subject. 644 "province": "A String", # The province, territory, or regional state of the subject. 645 "streetAddress": "A String", # The street address of the subject. 646 }, 647 "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. 648 "customSans": [ # Contains additional subject alternative name values. 649 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 650 "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). 651 "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. 652 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 653 42, 654 ], 655 }, 656 "value": "A String", # Required. The value of this X.509 extension. 657 }, 658 ], 659 "dnsNames": [ # Contains only valid, fully-qualified host names. 660 "A String", 661 ], 662 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 663 "A String", 664 ], 665 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 666 "A String", 667 ], 668 "uris": [ # Contains only valid RFC 3986 URIs. 669 "A String", 670 ], 671 }, 672 }, 673 "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. 674 "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. 675 }, 676 "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. 677 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 678 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 679 "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). 680 "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. 681 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 682 42, 683 ], 684 }, 685 "value": "A String", # Required. The value of this X.509 extension. 686 }, 687 ], 688 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 689 "A String", 690 ], 691 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 692 "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. 693 "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. 694 }, 695 "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. 696 "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. 697 "certSign": True or False, # The key may be used to sign certificates. 698 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 699 "crlSign": True or False, # The key may be used sign certificate revocation lists. 700 "dataEncipherment": True or False, # The key may be used to encipher data. 701 "decipherOnly": True or False, # The key may be used to decipher only. 702 "digitalSignature": True or False, # The key may be used for digital signatures. 703 "encipherOnly": True or False, # The key may be used to encipher only. 704 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 705 "keyEncipherment": True or False, # The key may be used to encipher other keys. 706 }, 707 "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. 708 "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. 709 "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". 710 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 711 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 712 "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. 713 "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". 714 }, 715 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 716 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 717 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 718 42, 719 ], 720 }, 721 ], 722 }, 723 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 724 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 725 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 726 42, 727 ], 728 }, 729 ], 730 }, 731 }, 732 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 733 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 734 "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. 735 "format": "A String", # Required. The format of the public key. 736 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 737 }, 738 "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. 739 "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. 740 "commonName": "A String", # The "common name" of the subject. 741 "countryCode": "A String", # The country code of the subject. 742 "locality": "A String", # The locality or city of the subject. 743 "organization": "A String", # The organization of the subject. 744 "organizationalUnit": "A String", # The organizational_unit of the subject. 745 "postalCode": "A String", # The postal code of the subject. 746 "province": "A String", # The province, territory, or regional state of the subject. 747 "streetAddress": "A String", # The street address of the subject. 748 }, 749 "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. 750 "customSans": [ # Contains additional subject alternative name values. 751 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 752 "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). 753 "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. 754 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 755 42, 756 ], 757 }, 758 "value": "A String", # Required. The value of this X.509 extension. 759 }, 760 ], 761 "dnsNames": [ # Contains only valid, fully-qualified host names. 762 "A String", 763 ], 764 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 765 "A String", 766 ], 767 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 768 "A String", 769 ], 770 "uris": [ # Contains only valid RFC 3986 URIs. 771 "A String", 772 ], 773 }, 774 }, 775 "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. 776 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 777 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 778 "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). 779 "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. 780 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 781 42, 782 ], 783 }, 784 "value": "A String", # Required. The value of this X.509 extension. 785 }, 786 ], 787 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 788 "A String", 789 ], 790 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 791 "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. 792 "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. 793 }, 794 "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. 795 "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. 796 "certSign": True or False, # The key may be used to sign certificates. 797 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 798 "crlSign": True or False, # The key may be used sign certificate revocation lists. 799 "dataEncipherment": True or False, # The key may be used to encipher data. 800 "decipherOnly": True or False, # The key may be used to decipher only. 801 "digitalSignature": True or False, # The key may be used for digital signatures. 802 "encipherOnly": True or False, # The key may be used to encipher only. 803 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 804 "keyEncipherment": True or False, # The key may be used to encipher other keys. 805 }, 806 "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. 807 "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. 808 "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". 809 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 810 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 811 "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. 812 "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". 813 }, 814 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 815 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 816 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 817 42, 818 ], 819 }, 820 ], 821 }, 822 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 823 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 824 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 825 42, 826 ], 827 }, 828 ], 829 }, 830 }, 831 "createTime": "A String", # Output only. The time at which this Certificate was created. 832 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 833 "labels": { # Optional. Labels with user-defined metadata. 834 "a_key": "A String", 835 }, 836 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 837 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 838 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 839 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 840 "A String", 841 ], 842 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 843 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 844 "revocationState": "A String", # Indicates why a Certificate was revoked. 845 "revocationTime": "A String", # The time at which this Certificate was revoked. 846 }, 847 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 848 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 849}</pre> 850</div> 851 852<div class="method"> 853 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 854 <pre>Lists Certificates. 855 856Args: 857 parent: string, Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/caPools/*`. (required) 858 filter: string, Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support). 859 orderBy: string, Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support). 860 pageSize: integer, Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default. 861 pageToken: string, Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token. 862 x__xgafv: string, V1 error format. 863 Allowed values 864 1 - v1 error format 865 2 - v2 error format 866 867Returns: 868 An object of the form: 869 870 { # Response message for CertificateAuthorityService.ListCertificates. 871 "certificates": [ # The list of Certificates. 872 { # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 873 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 874 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 875 "A String", 876 ], 877 "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 878 "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. 879 }, 880 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 881 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 882 }, 883 "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 884 "A String", 885 ], 886 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 887 "format": "A String", # Required. The format of the public key. 888 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 889 }, 890 "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. 891 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 892 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 893 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 894 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 895 "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. 896 "commonName": "A String", # The "common name" of the subject. 897 "countryCode": "A String", # The country code of the subject. 898 "locality": "A String", # The locality or city of the subject. 899 "organization": "A String", # The organization of the subject. 900 "organizationalUnit": "A String", # The organizational_unit of the subject. 901 "postalCode": "A String", # The postal code of the subject. 902 "province": "A String", # The province, territory, or regional state of the subject. 903 "streetAddress": "A String", # The street address of the subject. 904 }, 905 "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. 906 "customSans": [ # Contains additional subject alternative name values. 907 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 908 "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). 909 "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. 910 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 911 42, 912 ], 913 }, 914 "value": "A String", # Required. The value of this X.509 extension. 915 }, 916 ], 917 "dnsNames": [ # Contains only valid, fully-qualified host names. 918 "A String", 919 ], 920 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 921 "A String", 922 ], 923 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 924 "A String", 925 ], 926 "uris": [ # Contains only valid RFC 3986 URIs. 927 "A String", 928 ], 929 }, 930 }, 931 "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. 932 "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. 933 }, 934 "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. 935 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 936 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 937 "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). 938 "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. 939 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 940 42, 941 ], 942 }, 943 "value": "A String", # Required. The value of this X.509 extension. 944 }, 945 ], 946 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 947 "A String", 948 ], 949 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 950 "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. 951 "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. 952 }, 953 "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. 954 "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. 955 "certSign": True or False, # The key may be used to sign certificates. 956 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 957 "crlSign": True or False, # The key may be used sign certificate revocation lists. 958 "dataEncipherment": True or False, # The key may be used to encipher data. 959 "decipherOnly": True or False, # The key may be used to decipher only. 960 "digitalSignature": True or False, # The key may be used for digital signatures. 961 "encipherOnly": True or False, # The key may be used to encipher only. 962 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 963 "keyEncipherment": True or False, # The key may be used to encipher other keys. 964 }, 965 "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. 966 "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. 967 "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". 968 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 969 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 970 "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. 971 "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". 972 }, 973 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 974 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 975 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 976 42, 977 ], 978 }, 979 ], 980 }, 981 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 982 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 983 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 984 42, 985 ], 986 }, 987 ], 988 }, 989 }, 990 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 991 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 992 "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. 993 "format": "A String", # Required. The format of the public key. 994 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 995 }, 996 "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. 997 "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. 998 "commonName": "A String", # The "common name" of the subject. 999 "countryCode": "A String", # The country code of the subject. 1000 "locality": "A String", # The locality or city of the subject. 1001 "organization": "A String", # The organization of the subject. 1002 "organizationalUnit": "A String", # The organizational_unit of the subject. 1003 "postalCode": "A String", # The postal code of the subject. 1004 "province": "A String", # The province, territory, or regional state of the subject. 1005 "streetAddress": "A String", # The street address of the subject. 1006 }, 1007 "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. 1008 "customSans": [ # Contains additional subject alternative name values. 1009 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1010 "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). 1011 "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. 1012 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1013 42, 1014 ], 1015 }, 1016 "value": "A String", # Required. The value of this X.509 extension. 1017 }, 1018 ], 1019 "dnsNames": [ # Contains only valid, fully-qualified host names. 1020 "A String", 1021 ], 1022 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1023 "A String", 1024 ], 1025 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1026 "A String", 1027 ], 1028 "uris": [ # Contains only valid RFC 3986 URIs. 1029 "A String", 1030 ], 1031 }, 1032 }, 1033 "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. 1034 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1035 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1036 "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). 1037 "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. 1038 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1039 42, 1040 ], 1041 }, 1042 "value": "A String", # Required. The value of this X.509 extension. 1043 }, 1044 ], 1045 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1046 "A String", 1047 ], 1048 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1049 "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. 1050 "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. 1051 }, 1052 "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. 1053 "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. 1054 "certSign": True or False, # The key may be used to sign certificates. 1055 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1056 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1057 "dataEncipherment": True or False, # The key may be used to encipher data. 1058 "decipherOnly": True or False, # The key may be used to decipher only. 1059 "digitalSignature": True or False, # The key may be used for digital signatures. 1060 "encipherOnly": True or False, # The key may be used to encipher only. 1061 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1062 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1063 }, 1064 "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. 1065 "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. 1066 "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". 1067 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1068 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1069 "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. 1070 "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". 1071 }, 1072 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1073 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1074 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1075 42, 1076 ], 1077 }, 1078 ], 1079 }, 1080 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1081 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1082 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1083 42, 1084 ], 1085 }, 1086 ], 1087 }, 1088 }, 1089 "createTime": "A String", # Output only. The time at which this Certificate was created. 1090 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 1091 "labels": { # Optional. Labels with user-defined metadata. 1092 "a_key": "A String", 1093 }, 1094 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 1095 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 1096 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 1097 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 1098 "A String", 1099 ], 1100 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 1101 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 1102 "revocationState": "A String", # Indicates why a Certificate was revoked. 1103 "revocationTime": "A String", # The time at which this Certificate was revoked. 1104 }, 1105 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 1106 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 1107 }, 1108 ], 1109 "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCertificatesRequest.next_page_token to retrieve the next page of results. 1110 "unreachable": [ # A list of locations (e.g. "us-west1") that could not be reached. 1111 "A String", 1112 ], 1113}</pre> 1114</div> 1115 1116<div class="method"> 1117 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1118 <pre>Retrieves the next page of results. 1119 1120Args: 1121 previous_request: The request for the previous page. (required) 1122 previous_response: The response from the request for the previous page. (required) 1123 1124Returns: 1125 A request object that you can call 'execute()' on to request the next 1126 page. Returns None if there are no more items in the collection. 1127 </pre> 1128</div> 1129 1130<div class="method"> 1131 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> 1132 <pre>Update a Certificate. Currently, the only field you can update is the labels field. 1133 1134Args: 1135 name: string, Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. (required) 1136 body: object, The request body. 1137 The object takes the form of: 1138 1139{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 1140 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 1141 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 1142 "A String", 1143 ], 1144 "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 1145 "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. 1146 }, 1147 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 1148 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 1149 }, 1150 "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 1151 "A String", 1152 ], 1153 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 1154 "format": "A String", # Required. The format of the public key. 1155 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1156 }, 1157 "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. 1158 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 1159 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 1160 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 1161 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 1162 "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. 1163 "commonName": "A String", # The "common name" of the subject. 1164 "countryCode": "A String", # The country code of the subject. 1165 "locality": "A String", # The locality or city of the subject. 1166 "organization": "A String", # The organization of the subject. 1167 "organizationalUnit": "A String", # The organizational_unit of the subject. 1168 "postalCode": "A String", # The postal code of the subject. 1169 "province": "A String", # The province, territory, or regional state of the subject. 1170 "streetAddress": "A String", # The street address of the subject. 1171 }, 1172 "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. 1173 "customSans": [ # Contains additional subject alternative name values. 1174 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1175 "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). 1176 "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. 1177 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1178 42, 1179 ], 1180 }, 1181 "value": "A String", # Required. The value of this X.509 extension. 1182 }, 1183 ], 1184 "dnsNames": [ # Contains only valid, fully-qualified host names. 1185 "A String", 1186 ], 1187 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1188 "A String", 1189 ], 1190 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1191 "A String", 1192 ], 1193 "uris": [ # Contains only valid RFC 3986 URIs. 1194 "A String", 1195 ], 1196 }, 1197 }, 1198 "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. 1199 "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. 1200 }, 1201 "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. 1202 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1203 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1204 "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). 1205 "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. 1206 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1207 42, 1208 ], 1209 }, 1210 "value": "A String", # Required. The value of this X.509 extension. 1211 }, 1212 ], 1213 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1214 "A String", 1215 ], 1216 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1217 "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. 1218 "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. 1219 }, 1220 "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. 1221 "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. 1222 "certSign": True or False, # The key may be used to sign certificates. 1223 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1224 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1225 "dataEncipherment": True or False, # The key may be used to encipher data. 1226 "decipherOnly": True or False, # The key may be used to decipher only. 1227 "digitalSignature": True or False, # The key may be used for digital signatures. 1228 "encipherOnly": True or False, # The key may be used to encipher only. 1229 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1230 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1231 }, 1232 "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. 1233 "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. 1234 "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". 1235 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1236 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1237 "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. 1238 "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". 1239 }, 1240 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1241 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1242 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1243 42, 1244 ], 1245 }, 1246 ], 1247 }, 1248 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1249 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1250 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1251 42, 1252 ], 1253 }, 1254 ], 1255 }, 1256 }, 1257 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 1258 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 1259 "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. 1260 "format": "A String", # Required. The format of the public key. 1261 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1262 }, 1263 "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. 1264 "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. 1265 "commonName": "A String", # The "common name" of the subject. 1266 "countryCode": "A String", # The country code of the subject. 1267 "locality": "A String", # The locality or city of the subject. 1268 "organization": "A String", # The organization of the subject. 1269 "organizationalUnit": "A String", # The organizational_unit of the subject. 1270 "postalCode": "A String", # The postal code of the subject. 1271 "province": "A String", # The province, territory, or regional state of the subject. 1272 "streetAddress": "A String", # The street address of the subject. 1273 }, 1274 "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. 1275 "customSans": [ # Contains additional subject alternative name values. 1276 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1277 "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). 1278 "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. 1279 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1280 42, 1281 ], 1282 }, 1283 "value": "A String", # Required. The value of this X.509 extension. 1284 }, 1285 ], 1286 "dnsNames": [ # Contains only valid, fully-qualified host names. 1287 "A String", 1288 ], 1289 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1290 "A String", 1291 ], 1292 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1293 "A String", 1294 ], 1295 "uris": [ # Contains only valid RFC 3986 URIs. 1296 "A String", 1297 ], 1298 }, 1299 }, 1300 "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. 1301 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1302 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1303 "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). 1304 "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. 1305 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1306 42, 1307 ], 1308 }, 1309 "value": "A String", # Required. The value of this X.509 extension. 1310 }, 1311 ], 1312 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1313 "A String", 1314 ], 1315 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1316 "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. 1317 "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. 1318 }, 1319 "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. 1320 "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. 1321 "certSign": True or False, # The key may be used to sign certificates. 1322 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1323 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1324 "dataEncipherment": True or False, # The key may be used to encipher data. 1325 "decipherOnly": True or False, # The key may be used to decipher only. 1326 "digitalSignature": True or False, # The key may be used for digital signatures. 1327 "encipherOnly": True or False, # The key may be used to encipher only. 1328 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1329 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1330 }, 1331 "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. 1332 "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. 1333 "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". 1334 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1335 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1336 "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. 1337 "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". 1338 }, 1339 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1340 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1341 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1342 42, 1343 ], 1344 }, 1345 ], 1346 }, 1347 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1348 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1349 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1350 42, 1351 ], 1352 }, 1353 ], 1354 }, 1355 }, 1356 "createTime": "A String", # Output only. The time at which this Certificate was created. 1357 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 1358 "labels": { # Optional. Labels with user-defined metadata. 1359 "a_key": "A String", 1360 }, 1361 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 1362 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 1363 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 1364 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 1365 "A String", 1366 ], 1367 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 1368 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 1369 "revocationState": "A String", # Indicates why a Certificate was revoked. 1370 "revocationTime": "A String", # The time at which this Certificate was revoked. 1371 }, 1372 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 1373 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 1374} 1375 1376 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). 1377 updateMask: string, Required. A list of fields to be updated in this request. 1378 x__xgafv: string, V1 error format. 1379 Allowed values 1380 1 - v1 error format 1381 2 - v2 error format 1382 1383Returns: 1384 An object of the form: 1385 1386 { # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 1387 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 1388 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 1389 "A String", 1390 ], 1391 "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 1392 "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. 1393 }, 1394 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 1395 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 1396 }, 1397 "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 1398 "A String", 1399 ], 1400 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 1401 "format": "A String", # Required. The format of the public key. 1402 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1403 }, 1404 "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. 1405 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 1406 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 1407 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 1408 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 1409 "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. 1410 "commonName": "A String", # The "common name" of the subject. 1411 "countryCode": "A String", # The country code of the subject. 1412 "locality": "A String", # The locality or city of the subject. 1413 "organization": "A String", # The organization of the subject. 1414 "organizationalUnit": "A String", # The organizational_unit of the subject. 1415 "postalCode": "A String", # The postal code of the subject. 1416 "province": "A String", # The province, territory, or regional state of the subject. 1417 "streetAddress": "A String", # The street address of the subject. 1418 }, 1419 "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. 1420 "customSans": [ # Contains additional subject alternative name values. 1421 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1422 "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). 1423 "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. 1424 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1425 42, 1426 ], 1427 }, 1428 "value": "A String", # Required. The value of this X.509 extension. 1429 }, 1430 ], 1431 "dnsNames": [ # Contains only valid, fully-qualified host names. 1432 "A String", 1433 ], 1434 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1435 "A String", 1436 ], 1437 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1438 "A String", 1439 ], 1440 "uris": [ # Contains only valid RFC 3986 URIs. 1441 "A String", 1442 ], 1443 }, 1444 }, 1445 "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. 1446 "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. 1447 }, 1448 "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. 1449 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1450 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1451 "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). 1452 "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. 1453 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1454 42, 1455 ], 1456 }, 1457 "value": "A String", # Required. The value of this X.509 extension. 1458 }, 1459 ], 1460 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1461 "A String", 1462 ], 1463 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1464 "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. 1465 "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. 1466 }, 1467 "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. 1468 "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. 1469 "certSign": True or False, # The key may be used to sign certificates. 1470 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1471 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1472 "dataEncipherment": True or False, # The key may be used to encipher data. 1473 "decipherOnly": True or False, # The key may be used to decipher only. 1474 "digitalSignature": True or False, # The key may be used for digital signatures. 1475 "encipherOnly": True or False, # The key may be used to encipher only. 1476 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1477 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1478 }, 1479 "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. 1480 "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. 1481 "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". 1482 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1483 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1484 "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. 1485 "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". 1486 }, 1487 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1488 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1489 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1490 42, 1491 ], 1492 }, 1493 ], 1494 }, 1495 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1496 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1497 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1498 42, 1499 ], 1500 }, 1501 ], 1502 }, 1503 }, 1504 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 1505 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 1506 "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. 1507 "format": "A String", # Required. The format of the public key. 1508 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1509 }, 1510 "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. 1511 "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. 1512 "commonName": "A String", # The "common name" of the subject. 1513 "countryCode": "A String", # The country code of the subject. 1514 "locality": "A String", # The locality or city of the subject. 1515 "organization": "A String", # The organization of the subject. 1516 "organizationalUnit": "A String", # The organizational_unit of the subject. 1517 "postalCode": "A String", # The postal code of the subject. 1518 "province": "A String", # The province, territory, or regional state of the subject. 1519 "streetAddress": "A String", # The street address of the subject. 1520 }, 1521 "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. 1522 "customSans": [ # Contains additional subject alternative name values. 1523 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1524 "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). 1525 "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. 1526 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1527 42, 1528 ], 1529 }, 1530 "value": "A String", # Required. The value of this X.509 extension. 1531 }, 1532 ], 1533 "dnsNames": [ # Contains only valid, fully-qualified host names. 1534 "A String", 1535 ], 1536 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1537 "A String", 1538 ], 1539 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1540 "A String", 1541 ], 1542 "uris": [ # Contains only valid RFC 3986 URIs. 1543 "A String", 1544 ], 1545 }, 1546 }, 1547 "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. 1548 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1549 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1550 "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). 1551 "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. 1552 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1553 42, 1554 ], 1555 }, 1556 "value": "A String", # Required. The value of this X.509 extension. 1557 }, 1558 ], 1559 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1560 "A String", 1561 ], 1562 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1563 "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. 1564 "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. 1565 }, 1566 "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. 1567 "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. 1568 "certSign": True or False, # The key may be used to sign certificates. 1569 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1570 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1571 "dataEncipherment": True or False, # The key may be used to encipher data. 1572 "decipherOnly": True or False, # The key may be used to decipher only. 1573 "digitalSignature": True or False, # The key may be used for digital signatures. 1574 "encipherOnly": True or False, # The key may be used to encipher only. 1575 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1576 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1577 }, 1578 "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. 1579 "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. 1580 "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". 1581 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1582 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1583 "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. 1584 "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". 1585 }, 1586 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1587 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1588 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1589 42, 1590 ], 1591 }, 1592 ], 1593 }, 1594 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1595 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1596 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1597 42, 1598 ], 1599 }, 1600 ], 1601 }, 1602 }, 1603 "createTime": "A String", # Output only. The time at which this Certificate was created. 1604 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 1605 "labels": { # Optional. Labels with user-defined metadata. 1606 "a_key": "A String", 1607 }, 1608 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 1609 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 1610 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 1611 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 1612 "A String", 1613 ], 1614 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 1615 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 1616 "revocationState": "A String", # Indicates why a Certificate was revoked. 1617 "revocationTime": "A String", # The time at which this Certificate was revoked. 1618 }, 1619 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 1620 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 1621}</pre> 1622</div> 1623 1624<div class="method"> 1625 <code class="details" id="revoke">revoke(name, body=None, x__xgafv=None)</code> 1626 <pre>Revoke a Certificate. 1627 1628Args: 1629 name: string, Required. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. (required) 1630 body: object, The request body. 1631 The object takes the form of: 1632 1633{ # Request message for CertificateAuthorityService.RevokeCertificate. 1634 "reason": "A String", # Required. The RevocationReason for revoking this certificate. 1635 "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). 1636} 1637 1638 x__xgafv: string, V1 error format. 1639 Allowed values 1640 1 - v1 error format 1641 2 - v2 error format 1642 1643Returns: 1644 An object of the form: 1645 1646 { # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority. 1647 "certificateDescription": { # A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. # Output only. A structured description of the issued X.509 certificate. 1648 "aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate. 1649 "A String", 1650 ], 1651 "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 1652 "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. 1653 }, 1654 "certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate. 1655 "sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate. 1656 }, 1657 "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 1658 "A String", 1659 ], 1660 "publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate. 1661 "format": "A String", # Required. The format of the public key. 1662 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1663 }, 1664 "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. 1665 "hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal. 1666 "lifetime": "A String", # For convenience, the actual lifetime of an issued certificate. 1667 "notAfterTime": "A String", # The time after which the certificate is expired. Per RFC 5280, the validity period for a certificate is the period of time from not_before_time through not_after_time, inclusive. Corresponds to 'not_before_time' + 'lifetime' - 1 second. 1668 "notBeforeTime": "A String", # The time at which the certificate becomes valid. 1669 "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. 1670 "commonName": "A String", # The "common name" of the subject. 1671 "countryCode": "A String", # The country code of the subject. 1672 "locality": "A String", # The locality or city of the subject. 1673 "organization": "A String", # The organization of the subject. 1674 "organizationalUnit": "A String", # The organizational_unit of the subject. 1675 "postalCode": "A String", # The postal code of the subject. 1676 "province": "A String", # The province, territory, or regional state of the subject. 1677 "streetAddress": "A String", # The street address of the subject. 1678 }, 1679 "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. 1680 "customSans": [ # Contains additional subject alternative name values. 1681 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1682 "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). 1683 "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. 1684 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1685 42, 1686 ], 1687 }, 1688 "value": "A String", # Required. The value of this X.509 extension. 1689 }, 1690 ], 1691 "dnsNames": [ # Contains only valid, fully-qualified host names. 1692 "A String", 1693 ], 1694 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1695 "A String", 1696 ], 1697 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1698 "A String", 1699 ], 1700 "uris": [ # Contains only valid RFC 3986 URIs. 1701 "A String", 1702 ], 1703 }, 1704 }, 1705 "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. 1706 "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. 1707 }, 1708 "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. 1709 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1710 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1711 "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). 1712 "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. 1713 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1714 42, 1715 ], 1716 }, 1717 "value": "A String", # Required. The value of this X.509 extension. 1718 }, 1719 ], 1720 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1721 "A String", 1722 ], 1723 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1724 "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. 1725 "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. 1726 }, 1727 "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. 1728 "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. 1729 "certSign": True or False, # The key may be used to sign certificates. 1730 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1731 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1732 "dataEncipherment": True or False, # The key may be used to encipher data. 1733 "decipherOnly": True or False, # The key may be used to decipher only. 1734 "digitalSignature": True or False, # The key may be used for digital signatures. 1735 "encipherOnly": True or False, # The key may be used to encipher only. 1736 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1737 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1738 }, 1739 "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. 1740 "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. 1741 "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". 1742 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1743 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1744 "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. 1745 "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". 1746 }, 1747 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1748 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1749 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1750 42, 1751 ], 1752 }, 1753 ], 1754 }, 1755 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1756 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1757 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1758 42, 1759 ], 1760 }, 1761 ], 1762 }, 1763 }, 1764 "certificateTemplate": "A String", # Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. 1765 "config": { # A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. # Immutable. A description of the certificate and key that does not require X.509 or ASN.1. 1766 "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. 1767 "format": "A String", # Required. The format of the public key. 1768 "key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field. 1769 }, 1770 "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. 1771 "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. 1772 "commonName": "A String", # The "common name" of the subject. 1773 "countryCode": "A String", # The country code of the subject. 1774 "locality": "A String", # The locality or city of the subject. 1775 "organization": "A String", # The organization of the subject. 1776 "organizationalUnit": "A String", # The organizational_unit of the subject. 1777 "postalCode": "A String", # The postal code of the subject. 1778 "province": "A String", # The province, territory, or regional state of the subject. 1779 "streetAddress": "A String", # The street address of the subject. 1780 }, 1781 "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. 1782 "customSans": [ # Contains additional subject alternative name values. 1783 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1784 "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). 1785 "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. 1786 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1787 42, 1788 ], 1789 }, 1790 "value": "A String", # Required. The value of this X.509 extension. 1791 }, 1792 ], 1793 "dnsNames": [ # Contains only valid, fully-qualified host names. 1794 "A String", 1795 ], 1796 "emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses. 1797 "A String", 1798 ], 1799 "ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses. 1800 "A String", 1801 ], 1802 "uris": [ # Contains only valid RFC 3986 URIs. 1803 "A String", 1804 ], 1805 }, 1806 }, 1807 "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. 1808 "additionalExtensions": [ # Optional. Describes custom X.509 extensions. 1809 { # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs. 1810 "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). 1811 "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. 1812 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1813 42, 1814 ], 1815 }, 1816 "value": "A String", # Required. The value of this X.509 extension. 1817 }, 1818 ], 1819 "aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. 1820 "A String", 1821 ], 1822 "caOptions": { # Describes values that are relevant in a CA certificate. # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. 1823 "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. 1824 "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. 1825 }, 1826 "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. 1827 "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. 1828 "certSign": True or False, # The key may be used to sign certificates. 1829 "contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". 1830 "crlSign": True or False, # The key may be used sign certificate revocation lists. 1831 "dataEncipherment": True or False, # The key may be used to encipher data. 1832 "decipherOnly": True or False, # The key may be used to decipher only. 1833 "digitalSignature": True or False, # The key may be used for digital signatures. 1834 "encipherOnly": True or False, # The key may be used to encipher only. 1835 "keyAgreement": True or False, # The key may be used in a key agreement protocol. 1836 "keyEncipherment": True or False, # The key may be used to encipher other keys. 1837 }, 1838 "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. 1839 "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. 1840 "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". 1841 "emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". 1842 "ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". 1843 "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. 1844 "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". 1845 }, 1846 "unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message. 1847 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1848 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1849 42, 1850 ], 1851 }, 1852 ], 1853 }, 1854 "policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. 1855 { # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages. 1856 "objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first. 1857 42, 1858 ], 1859 }, 1860 ], 1861 }, 1862 }, 1863 "createTime": "A String", # Output only. The time at which this Certificate was created. 1864 "issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. 1865 "labels": { # Optional. Labels with user-defined metadata. 1866 "a_key": "A String", 1867 }, 1868 "lifetime": "A String", # Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. 1869 "name": "A String", # Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. 1870 "pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate. 1871 "pemCertificateChain": [ # Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. 1872 "A String", 1873 ], 1874 "pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR). 1875 "revocationDetails": { # Describes fields that are relavent to the revocation of a Certificate. # Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present. 1876 "revocationState": "A String", # Indicates why a Certificate was revoked. 1877 "revocationTime": "A String", # The time at which this Certificate was revoked. 1878 }, 1879 "subjectMode": "A String", # Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. 1880 "updateTime": "A String", # Output only. The time at which this Certificate was updated. 1881}</pre> 1882</div> 1883 1884</body></html>