Close httplib2 connections.
Create a new Certificate in a given Project, Location from a particular CaPool.
Returns a Certificate.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Certificates.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update a Certificate. Currently, the only field you can update is the labels field.
revoke(name, body=None, x__xgafv=None)
Revoke a Certificate.
close()
Close httplib2 connections.
create(parent, body=None, certificateId=None, issuingCertificateAuthorityId=None, requestId=None, validateOnly=None, x__xgafv=None)
Create a new Certificate in a given Project, Location from a particular CaPool.
Args:
parent: string, Required. The resource name of the CaPool associated with the Certificate, in the format `projects/*/locations/*/caPools/*`. (required)
body: object, The request body.
The object takes the form of:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}
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.
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".
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).
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}
get(name, x__xgafv=None)
Returns a Certificate.
Args:
name: string, Required. The name of the Certificate to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Certificates.
Args:
parent: string, Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/caPools/*`. (required)
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).
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).
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.
pageToken: string, Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for CertificateAuthorityService.ListCertificates.
"certificates": [ # The list of Certificates.
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
},
],
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCertificatesRequest.page_token to retrieve the next page of results.
"unreachable": [ # A list of locations (e.g. "us-west1") that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Update a Certificate. Currently, the only field you can update is the labels field.
Args:
name: string, Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. (required)
body: object, The request body.
The object takes the form of:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}
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).
updateMask: string, Required. A list of fields to be updated in this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}
revoke(name, body=None, x__xgafv=None)
Revoke a Certificate.
Args:
name: string, Required. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CertificateAuthorityService.RevokeCertificate.
"reason": "A String", # Required. The RevocationReason for revoking this certificate.
"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 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).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.
"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.
"aiaIssuingCertificateUrls": [ # Describes lists of issuer CA certificate URLs that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"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
"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.
},
"certFingerprint": { # A group of fingerprints for the x509 certificate. # The hash of the x.509 certificate.
"sha256Hash": "A String", # The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.
},
"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
"A String",
],
"publicKey": { # A PublicKey describes a public key. # The public key that corresponds to an issued certificate.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"hexSerialNumber": "A String", # The serial number encoded in lowercase hexadecimal.
"lifetime": "A String", # For convenience, the actual lifetime of an issued certificate.
"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.
"notBeforeTime": "A String", # The time at which the certificate becomes valid.
"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.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
"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.
},
"tbsCertificateDigest": "A String", # The hash of the pre-signed certificate, which will be signed by the CA. Corresponds to the TBS Certificate in https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be populated.
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"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.
"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.
"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.
"format": "A String", # Required. The format of the public key.
"key": "A String", # Required. A public key. The padding and encoding must match with the `KeyFormat` value specified for the `format` field.
},
"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.
"subject": { # Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate. # Optional. Contains distinguished name fields such as the common name, location and organization.
"commonName": "A String", # The "common name" of the subject.
"countryCode": "A String", # The country code of the subject.
"locality": "A String", # The locality or city of the subject.
"organization": "A String", # The organization of the subject.
"organizationalUnit": "A String", # The organizational_unit of the subject.
"postalCode": "A String", # The postal code of the subject.
"province": "A String", # The province, territory, or regional state of the subject.
"streetAddress": "A String", # The street address of the subject.
},
"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.
"customSans": [ # Contains additional subject alternative name values. For each custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"dnsNames": [ # Contains only valid, fully-qualified host names.
"A String",
],
"emailAddresses": [ # Contains only valid RFC 2822 E-mail addresses.
"A String",
],
"ipAddresses": [ # Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
"A String",
],
"uris": [ # Contains only valid RFC 3986 URIs.
"A String",
],
},
},
"subjectKeyId": { # A KeyId identifies a specific public key, usually by hashing the public key. # Optional. When specified this provides a custom SKI to be used in the certificate. This should only be used to maintain a SKI of an existing CA originally created outside CA service, which was not generated using method (1) described in RFC 5280 section 4.2.1.2.
"keyId": "A String", # Required. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.
},
"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.
"additionalExtensions": [ # Optional. Describes custom X.509 extensions.
{ # An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
"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).
"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.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
"value": "A String", # Required. The value of this X.509 extension.
},
],
"aiaOcspServers": [ # Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
"A String",
],
"caOptions": { # Describes the X.509 basic constraints extension, per [RFC 5280 section 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9) # Optional. Describes options in this X509Parameters that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates.
"isCa": True or False, # Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate.
"maxIssuerPathLength": 42, # Optional. Refers to the path length constraint field in the 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 certificate.
},
"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.
"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.
"certSign": True or False, # The key may be used to sign certificates.
"contentCommitment": True or False, # The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
"crlSign": True or False, # The key may be used sign certificate revocation lists.
"dataEncipherment": True or False, # The key may be used to encipher data.
"decipherOnly": True or False, # The key may be used to decipher only.
"digitalSignature": True or False, # The key may be used for digital signatures.
"encipherOnly": True or False, # The key may be used to encipher only.
"keyAgreement": True or False, # The key may be used in a key agreement protocol.
"keyEncipherment": True or False, # The key may be used to encipher other keys.
},
"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.
"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.
"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".
"emailProtection": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
"ocspSigning": True or False, # Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
"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.
"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".
},
"unknownExtendedKeyUsages": [ # Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
"nameConstraints": { # Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10 # Optional. Describes the X.509 name constraints extension.
"critical": True or False, # Indicates whether or not the name constraints are marked critical.
"excludedDnsNames": [ # Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"excludedEmailAddresses": [ # Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"excludedIpRanges": [ # Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"excludedUris": [ # Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
"permittedDnsNames": [ # Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, `example.com`, `www.example.com`, `www.sub.example.com` would satisfy `example.com` while `example1.com` does not.
"A String",
],
"permittedEmailAddresses": [ # Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. `.example.com`) to indicate all email addresses in that domain.
"A String",
],
"permittedIpRanges": [ # Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
"A String",
],
"permittedUris": [ # Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like `.example.com`)
"A String",
],
},
"policyIds": [ # Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
{ # An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
"objectIdPath": [ # Required. The parts of an OID path. The most significant parts of the path come first.
42,
],
},
],
},
},
"createTime": "A String", # Output only. The time at which this Certificate was created.
"issuerCertificateAuthority": "A String", # Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
"labels": { # Optional. Labels with user-defined metadata.
"a_key": "A String",
},
"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.
"name": "A String", # Identifier. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.
"pemCertificate": "A String", # Output only. The pem-encoded, signed X.509 certificate.
"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.
"A String",
],
"pemCsr": "A String", # Immutable. A pem-encoded X.509 certificate signing request (CSR).
"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.
"revocationState": "A String", # Indicates why a Certificate was revoked.
"revocationTime": "A String", # The time at which this Certificate was revoked.
},
"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.
"updateTime": "A String", # Output only. The time at which this Certificate was updated.
}