Types for Google Cloud Security Privateca v1beta1 API¶
- class google.cloud.security.privateca_v1beta1.types.ActivateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ActivateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ActivateCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- pem_ca_certificate¶
Required. The signed CA certificate issued from [FetchCertificateAuthorityCsrResponse.pem_csr][google.cloud.security.privateca.v1beta1.FetchCertificateAuthorityCsrResponse.pem_csr].
- Type
- subordinate_config¶
Required. Must include information about the issuer of ‘pem_ca_certificate’, and any further issuers until the self-signed CA.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.Certificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [Certificate][google.cloud.security.privateca.v1beta1.Certificate] corresponds to a signed X.509 certificate issued by a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- name¶
Output only. The resource path for this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] in the format
projects/*/locations/*/certificateAuthorities/*/certificates/*.- Type
- pem_csr¶
Immutable. A pem-encoded X.509 certificate signing request (CSR).
This field is a member of oneof
certificate_config.- Type
- config¶
Immutable. A description of the certificate and key that does not require X.509 or ASN.1.
This field is a member of oneof
certificate_config.
- lifetime¶
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.
- revocation_details¶
Output only. Details regarding the revocation of this [Certificate][google.cloud.security.privateca.v1beta1.Certificate]. This [Certificate][google.cloud.security.privateca.v1beta1.Certificate] is considered revoked if and only if this field is present.
- certificate_description¶
Output only. A structured description of the issued X.509 certificate.
- pem_certificate_chain¶
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.
- Type
MutableSequence[str]
- create_time¶
Output only. The time at which this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] was created.
- update_time¶
Output only. The time at which this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] was updated.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class RevocationDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes fields that are relavent to the revocation of a [Certificate][google.cloud.security.privateca.v1beta1.Certificate].
- revocation_state¶
Indicates why a [Certificate][google.cloud.security.privateca.v1beta1.Certificate] was revoked.
- revocation_time¶
The time at which this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] was revoked.
- class google.cloud.security.privateca_v1beta1.types.CertificateAuthority(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] represents an individual Certificate Authority. A [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] can be used to create [Certificates][google.cloud.security.privateca.v1beta1.Certificate].
- name¶
Output only. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- type_¶
Required. Immutable. The [Type][google.cloud.security.privateca.v1beta1.CertificateAuthority.Type] of this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- tier¶
Required. Immutable. The [Tier][google.cloud.security.privateca.v1beta1.CertificateAuthority.Tier] of this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- config¶
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
- lifetime¶
Required. The desired lifetime of the CA certificate. Used to create the “not_before_time” and “not_after_time” fields inside an X.509 certificate.
- key_spec¶
Required. Immutable. Used when issuing certificates for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. If this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR.
- certificate_policy¶
Optional. The [CertificateAuthorityPolicy][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy] to enforce when issuing [Certificates][google.cloud.security.privateca.v1beta1.Certificate] from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- issuing_options¶
Optional. The [IssuingOptions][google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions] to follow when issuing [Certificates][google.cloud.security.privateca.v1beta1.Certificate] from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- subordinate_config¶
Optional. If this is a subordinate [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must continue to validate.
- state¶
Output only. The [State][google.cloud.security.privateca.v1beta1.CertificateAuthority.State] for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- pem_ca_certificates¶
Output only. This [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]’s certificate chain, including the current [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]’s certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]’s certificate.
- Type
MutableSequence[str]
- ca_certificate_descriptions¶
Output only. A structured description of this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]’s CA certificate and its issuers. Ordered as self-to-root.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.CertificateDescription]
- gcs_bucket¶
Immutable. The name of a Cloud Storage bucket where this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as
gs://) or suffixes (such as.googleapis.com). For example, to use a bucket namedmy-bucket, you would simply specifymy-bucket. If not specified, a managed bucket will be created.- Type
- access_urls¶
Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.
- create_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] was created.
- update_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] was updated.
- delete_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will be deleted, if scheduled for deletion.
- class AccessUrls(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageURLs where a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will publish content.
- ca_certificate_access_url¶
The URL where this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]’s CA certificate is published. This will only be set for CAs that have been activated.
- Type
- class CertificateAuthorityPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe issuing policy for a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. [Certificates][google.cloud.security.privateca.v1beta1.Certificate] will not be successfully issued from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] if they violate the policy.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- allowed_config_list¶
Optional. All [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must match at least one listed [ReusableConfigWrapper][google.cloud.security.privateca.v1beta1.ReusableConfigWrapper] in the list.
This field is a member of oneof
config_policy.
- overwrite_config_values¶
Optional. All [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will use the provided configuration values, overwriting any requested configuration values.
This field is a member of oneof
config_policy.
- allowed_locations_and_organizations¶
Optional. If any [Subject][google.cloud.security.privateca.v1beta1.Subject] is specified here, then all [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must match at least one listed [Subject][google.cloud.security.privateca.v1beta1.Subject]. If a [Subject][google.cloud.security.privateca.v1beta1.Subject] has an empty field, any value will be allowed for that field.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.Subject]
- allowed_common_names¶
Optional. If any value is specified here, then all [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.
- Type
MutableSequence[str]
- allowed_sans¶
Optional. If a [AllowedSubjectAltNames][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames] is specified here, then all [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must match [AllowedSubjectAltNames][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames]. If no value or an empty value is specified, any value will be allowed for the [SubjectAltNames][google.cloud.security.privateca.v1beta1.SubjectAltNames] field.
- maximum_lifetime¶
Optional. The maximum lifetime allowed by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. Note that if the any part if the issuing chain expires before a [Certificate][google.cloud.security.privateca.v1beta1.Certificate]’s requested maximum_lifetime, the effective lifetime will be explicitly truncated.
- allowed_issuance_modes¶
Optional. If specified, then only methods allowed in the [IssuanceModes][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes] may be used to issue [Certificates][google.cloud.security.privateca.v1beta1.Certificate].
- class AllowedConfigList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- allowed_config_values¶
Required. All [Certificates][google.cloud.security.privateca.v1beta1.Certificate] issued by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] must match at least one listed [ReusableConfigWrapper][google.cloud.security.privateca.v1beta1.ReusableConfigWrapper]. If a [ReusableConfigWrapper][google.cloud.security.privateca.v1beta1.ReusableConfigWrapper] has an empty field, any value will be allowed for that field.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.ReusableConfigWrapper]
- class AllowedSubjectAltNames(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[AllowedSubjectAltNames][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames] specifies the allowed values for [SubjectAltNames][google.cloud.security.privateca.v1beta1.SubjectAltNames] by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] when issuing [Certificates][google.cloud.security.privateca.v1beta1.Certificate].
- allowed_dns_names¶
Optional. Contains valid, fully-qualified host names. Glob patterns are also supported. To allow an explicit wildcard certificate, escape with backlash (i.e.
\*). E.g. for globbed entries:*bar.comwill allowfoo.bar.com, but not*.bar.com, unless the [allow_globbing_dns_wildcards][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames.allow_globbing_dns_wildcards] field is set. E.g. for wildcard entries:\*.bar.comwill allow*.bar.com, but notfoo.bar.com.- Type
MutableSequence[str]
- allowed_uris¶
Optional. Contains valid RFC 3986 URIs. Glob patterns are also supported. To match across path seperators (i.e. ‘/’) use the double star glob pattern (i.e. ‘**’).
- Type
MutableSequence[str]
- allowed_email_addresses¶
Optional. Contains valid RFC 2822 E-mail addresses. Glob patterns are also supported.
- Type
MutableSequence[str]
- allowed_ips¶
Optional. Contains valid 32-bit IPv4 addresses and subnet ranges or RFC 4291 IPv6 addresses and subnet ranges. Subnet ranges are specified using the ‘/’ notation (e.g. 10.0.0.0/8, 2001:700:300:1800::/64). Glob patterns are supported only for ip address entries (i.e. not for subnet ranges).
- Type
MutableSequence[str]
- allow_globbing_dns_wildcards¶
Optional. Specifies if glob patterns used for [allowed_dns_names][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames.allowed_dns_names] allows wildcard certificates.
- Type
- class IssuanceModes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[IssuanceModes][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes] specifies the allowed ways in which [Certificates][google.cloud.security.privateca.v1beta1.Certificate] may be requested from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- allow_csr_based_issuance¶
Required. When true, allows callers to create [Certificates][google.cloud.security.privateca.v1beta1.Certificate] by specifying a CSR.
- Type
- class IssuingOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions that affect all certificates issued by a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- include_ca_cert_url¶
Required. When true, includes a URL to the issuing CA certificate in the “authority information access” X.509 extension.
- Type
- include_crl_access_url¶
Required. When true, includes a URL to the CRL corresponding to certificates issued from a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked.
- Type
- class KeyVersionSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Cloud KMS key configuration that a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will use.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- cloud_kms_key_version¶
Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key’s capabilities and properties.This field is a member of oneof
KeyVersion.- Type
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class SignHashAlgorithm(value)[source]¶
Bases:
proto.enums.EnumThe algorithm of a Cloud KMS CryptoKeyVersion of a [CryptoKey][google.cloud.kms.v1.CryptoKey] with the [CryptoKeyPurpose][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] value
ASYMMETRIC_SIGN. These values correspond to the [CryptoKeyVersionAlgorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] values. For RSA signing algorithms, the PSS algorithms should be preferred, use PKCS1 algorithms if required for compatibility. For further recommandations, see https://cloud.google.com/kms/docs/algorithms#algorithm_recommendations.- Values:
- SIGN_HASH_ALGORITHM_UNSPECIFIED (0):
Not specified.
- RSA_PSS_2048_SHA256 (1):
maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_2048_SHA256
- RSA_PSS_3072_SHA256 (2):
maps to CryptoKeyVersionAlgorithm. RSA_SIGN_PSS_3072_SHA256
- RSA_PSS_4096_SHA256 (3):
maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_4096_SHA256
- RSA_PKCS1_2048_SHA256 (6):
maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_2048_SHA256
- RSA_PKCS1_3072_SHA256 (7):
maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_3072_SHA256
- RSA_PKCS1_4096_SHA256 (8):
maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_4096_SHA256
- EC_P256_SHA256 (4):
maps to CryptoKeyVersionAlgorithm.EC_SIGN_P256_SHA256
- EC_P384_SHA384 (5):
maps to CryptoKeyVersionAlgorithm.EC_SIGN_P384_SHA384
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating if it can be used.
- Values:
- STATE_UNSPECIFIED (0):
Not specified.
- ENABLED (1):
Certificates can be issued from this CA. CRLs will be generated for this CA.
- DISABLED (2):
Certificates cannot be issued from this CA. CRLs will still be generated.
- PENDING_ACTIVATION (3):
Certificates cannot be issued from this CA. CRLs will not be generated.
- PENDING_DELETION (4):
Certificates cannot be issued from this CA. CRLs will not be generated.
- class Tier(value)[source]¶
Bases:
proto.enums.EnumThe tier of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating its supported functionality and/or billing SKU.
- Values:
- TIER_UNSPECIFIED (0):
Not specified.
- ENTERPRISE (1):
Enterprise tier.
- DEVOPS (2):
DevOps tier.
- class Type(value)[source]¶
Bases:
proto.enums.EnumThe type of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating its issuing chain.
- Values:
- TYPE_UNSPECIFIED (0):
Not specified.
- SELF_SIGNED (1):
Self-signed CA.
- SUBORDINATE (2):
Subordinate CA. Could be issued by a Private CA [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] or an unmanaged CA.
- class google.cloud.security.privateca_v1beta1.types.CertificateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateConfig][google.cloud.security.privateca.v1beta1.CertificateConfig] describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.
- subject_config¶
Required. Specifies some of the values in a certificate that are related to the subject.
- reusable_config¶
Required. Describes how some of the technical fields in a certificate should be populated.
- public_key¶
Optional. The public key that corresponds to this config. This is, for example, used when issuing [Certificates][google.cloud.security.privateca.v1beta1.Certificate], but not when creating a self-signed [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] or [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] CSR.
- class SubjectConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThese values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.
- subject¶
Required. Contains distinguished name fields such as the location and organization.
- subject_alt_name¶
Optional. The subject alternative name fields.
- class google.cloud.security.privateca_v1beta1.types.CertificateDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateDescription][google.cloud.security.privateca.v1beta1.CertificateDescription] describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.
- subject_description¶
Describes some of the values in a certificate that are related to the subject and lifetime.
- config_values¶
Describes some of the technical fields in a certificate.
- public_key¶
The public key that corresponds to an issued certificate.
- subject_key_id¶
Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
- authority_key_id¶
Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1
- crl_distribution_points¶
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
- Type
MutableSequence[str]
- aia_issuing_certificate_urls¶
Describes lists of issuer CA certificate URLs that appear in the “Authority Information Access” extension in the certificate.
- Type
MutableSequence[str]
- cert_fingerprint¶
The hash of the x.509 certificate.
- class CertificateFingerprint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA group of fingerprints for the x509 certificate.
- class KeyId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA KeyId identifies a specific public key, usually by hashing the public key.
- class SubjectDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThese values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.
- subject¶
Contains distinguished name fields such as the location and organization.
- subject_alt_name¶
The subject alternative name fields.
- lifetime¶
For convenience, the actual lifetime of an issued certificate. Corresponds to ‘not_after_time’ - ‘not_before_time’.
- not_before_time¶
The time at which the certificate becomes valid.
- not_after_time¶
The time at which the certificate expires.
- class google.cloud.security.privateca_v1beta1.types.CertificateRevocationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.
- name¶
Output only. The resource path for this [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] in the format
projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*.- Type
- revoked_certificates¶
Output only. The revoked serial numbers that appear in pem_crl.
- state¶
Output only. The [State][google.cloud.security.privateca.v1beta1.CertificateRevocationList.State] for this [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList].
- create_time¶
Output only. The time at which this [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] was created.
- update_time¶
Output only. The time at which this [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] was updated.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class RevokedCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a revoked [Certificate][google.cloud.security.privateca.v1beta1.Certificate].
- certificate¶
The resource path for the [Certificate][google.cloud.security.privateca.v1beta1.Certificate] in the format
projects/*/locations/*/certificateAuthorities/*/certificates/*.- Type
- hex_serial_number¶
The serial number of the [Certificate][google.cloud.security.privateca.v1beta1.Certificate].
- Type
- revocation_reason¶
The reason the [Certificate][google.cloud.security.privateca.v1beta1.Certificate] was revoked.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of a [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList], indicating if it is current.
- Values:
- STATE_UNSPECIFIED (0):
Not specified.
- ACTIVE (1):
The [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] is up to date.
- SUPERSEDED (2):
The [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] is no longer current.
- class google.cloud.security.privateca_v1beta1.types.CreateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateAuthority].
- parent¶
Required. The resource name of the location associated with the [CertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthority], in the format
projects/*/locations/*.- Type
- certificate_authority_id¶
Required. It must be unique within a location and match the regular expression
[a-zA-Z0-9_-]{1,63}- Type
- certificate_authority¶
Required. A [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] with initial field values.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.CreateCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificate].
- parent¶
Required. The resource name of the location and [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] associated with the [Certificate][google.cloud.security.privateca.v1beta1.Certificate], in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- certificate_id¶
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][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the Enterprise [CertificateAuthority.Tier][google.cloud.security.privateca.v1beta1.CertificateAuthority.Tier], but is optional and its value is ignored otherwise.- Type
- certificate¶
Required. A [Certificate][google.cloud.security.privateca.v1beta1.Certificate] with initial field values.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.DisableCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.DisableCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.DisableCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.EnableCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.EnableCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.EnableCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.FetchCertificateAuthorityCsrRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsr].
- class google.cloud.security.privateca_v1beta1.types.FetchCertificateAuthorityCsrResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsr].
- class google.cloud.security.privateca_v1beta1.types.GetCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateAuthority].
- class google.cloud.security.privateca_v1beta1.types.GetCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificate].
- class google.cloud.security.privateca_v1beta1.types.GetCertificateRevocationListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateRevocationList].
- class google.cloud.security.privateca_v1beta1.types.GetReusableConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetReusableConfig][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetReusableConfig].
- class google.cloud.security.privateca_v1beta1.types.KeyUsage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [KeyUsage][google.cloud.security.privateca.v1beta1.KeyUsage] describes key usage values that may appear in an X.509 certificate.
- base_key_usage¶
Describes high-level ways in which a key may be used.
- extended_key_usage¶
Detailed scenarios in which a key may be used.
- unknown_extended_key_usages¶
Used to describe extended key usages that are not listed in the [KeyUsage.ExtendedKeyUsageOptions][google.cloud.security.privateca.v1beta1.KeyUsage.ExtendedKeyUsageOptions] message.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.ObjectId]
- class ExtendedKeyUsageOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[KeyUsage.ExtendedKeyUsageOptions][google.cloud.security.privateca.v1beta1.KeyUsage.ExtendedKeyUsageOptions] has fields that correspond to certain common OIDs that could be specified as an extended key usage value.
- server_auth¶
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.
- Type
- client_auth¶
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.
- Type
- code_signing¶
Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as “Signing of downloadable executable code client authentication”.
- Type
- email_protection¶
Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as “Email protection”.
- Type
- time_stamping¶
Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as “Binding the hash of an object to a time”.
- Type
- class KeyUsageOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[KeyUsage.KeyUsageOptions][google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions] corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.
- content_commitment¶
The key may be used for cryptographic commitments. Note that this may also be referred to as “non-repudiation”.
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificateAuthoritiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthorities].
- parent¶
Required. The resource name of the location associated with the [CertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthority], in the format
projects/*/locations/*.- Type
- page_size¶
Optional. Limit on the number of [CertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthority] to include in the response. Further [CertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthority] can subsequently be obtained by including the [ListCertificateAuthoritiesResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.
- Type
- page_token¶
Optional. Pagination token, returned earlier via [ListCertificateAuthoritiesResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificateAuthoritiesResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificateAuthoritiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthorities].
- certificate_authorities¶
The list of [CertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthority].
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.CertificateAuthority]
- next_page_token¶
A token to retrieve next page of results. Pass this value in [ListCertificateAuthoritiesRequest.next_page_token][] to retrieve the next page of results.
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificateRevocationListsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationLists].
- parent¶
Required. The resource name of the location associated with the [CertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateRevocationList], in the format
projects/*/locations/*/certificateauthorities/*.- Type
- page_size¶
Optional. Limit on the number of [CertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateRevocationList] to include in the response. Further [CertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateRevocationList] can subsequently be obtained by including the [ListCertificateRevocationListsResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.
- Type
- page_token¶
Optional. Pagination token, returned earlier via [ListCertificateRevocationListsResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificateRevocationListsResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificateRevocationListsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationLists].
- certificate_revocation_lists¶
The list of [CertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateRevocationList].
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.CertificateRevocationList]
- next_page_token¶
A token to retrieve next page of results. Pass this value in [ListCertificateRevocationListsRequest.next_page_token][] to retrieve the next page of results.
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificates].
- parent¶
Required. The resource name of the location associated with the [Certificates][google.cloud.security.privateca.v1beta1.Certificate], in the format
projects/*/locations/*/certificateauthorities/*.- Type
- page_size¶
Optional. Limit on the number of [Certificates][google.cloud.security.privateca.v1beta1.Certificate] to include in the response. Further [Certificates][google.cloud.security.privateca.v1beta1.Certificate] can subsequently be obtained by including the [ListCertificatesResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificatesResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.
- Type
- page_token¶
Optional. Pagination token, returned earlier via [ListCertificatesResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListCertificatesResponse.next_page_token].
- Type
- filter¶
Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.
- Type
- order_by¶
Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.
- Type
- class google.cloud.security.privateca_v1beta1.types.ListCertificatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificates].
- certificates¶
The list of [Certificates][google.cloud.security.privateca.v1beta1.Certificate].
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.Certificate]
- next_page_token¶
A token to retrieve next page of results. Pass this value in [ListCertificatesRequest.next_page_token][] to retrieve the next page of results.
- Type
- class google.cloud.security.privateca_v1beta1.types.ListReusableConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListReusableConfigs][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigs].
- parent¶
Required. The resource name of the location associated with the [ReusableConfigs][google.cloud.security.privateca.v1beta1.ReusableConfig], in the format
projects/*/locations/*.- Type
- page_size¶
Optional. Limit on the number of [ReusableConfigs][google.cloud.security.privateca.v1beta1.ReusableConfig] to include in the response. Further [ReusableConfigs][google.cloud.security.privateca.v1beta1.ReusableConfig] can subsequently be obtained by including the [ListReusableConfigsResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.
- Type
- page_token¶
Optional. Pagination token, returned earlier via [ListReusableConfigsResponse.next_page_token][google.cloud.security.privateca.v1beta1.ListReusableConfigsResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1beta1.types.ListReusableConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListReusableConfigs][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigs].
- reusable_configs¶
The list of [ReusableConfigs][google.cloud.security.privateca.v1beta1.ReusableConfig].
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.ReusableConfig]
- next_page_token¶
A token to retrieve next page of results. Pass this value in [ListReusableConfigsRequest.next_page_token][] to retrieve the next page of results.
- Type
- class google.cloud.security.privateca_v1beta1.types.ObjectId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn [ObjectId][google.cloud.security.privateca.v1beta1.ObjectId] specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
- class google.cloud.security.privateca_v1beta1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.security.privateca_v1beta1.types.PublicKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [PublicKey][google.cloud.security.privateca.v1beta1.PublicKey] describes a public key.
- type_¶
Required. The type of public key.
- key¶
Required. A public key. Padding and encoding varies by ‘KeyType’ and is described along with the KeyType values.
- Type
- class KeyType(value)[source]¶
Bases:
proto.enums.EnumTypes of public keys that are supported. At a minimum, we support RSA and ECDSA, for the key sizes or curves listed: https://cloud.google.com/kms/docs/algorithms#asymmetric_signing_algorithms
- Values:
- KEY_TYPE_UNSPECIFIED (0):
Default unspecified value.
- PEM_RSA_KEY (1):
A PEM-encoded PKCS#1/RFC 3447 RSAPrivateKey structure.
- PEM_EC_KEY (2):
A PEM-encoded compressed NIST P-256/secp256r1/prime256v1 or P-384 key.
- class google.cloud.security.privateca_v1beta1.types.RestoreCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.RestoreCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RestoreCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.ReusableConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] refers to a managed [ReusableConfigValues][google.cloud.security.privateca.v1beta1.ReusableConfigValues]. Those, in turn, are 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.
- name¶
Output only. The resource path for this [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] in the format
projects/*/locations/*/reusableConfigs/*.- Type
- values¶
Required. The config values.
- description¶
Optional. A human-readable description of scenarios these ReusableConfigValues may be compatible with.
- Type
- create_time¶
Output only. The time at which this [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] was created.
- update_time¶
Output only. The time at which this [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] was updated.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.security.privateca_v1beta1.types.ReusableConfigValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [ReusableConfigValues][google.cloud.security.privateca.v1beta1.ReusableConfigValues] 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.
- key_usage¶
Optional. Indicates the intended use for keys that correspond to a certificate.
- ca_options¶
Optional. Describes options in this [ReusableConfigValues][google.cloud.security.privateca.v1beta1.ReusableConfigValues] that are relevant in a CA certificate.
- policy_ids¶
Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.ObjectId]
- aia_ocsp_servers¶
Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the “Authority Information Access” extension in the certificate.
- Type
MutableSequence[str]
- additional_extensions¶
Optional. Describes custom X.509 extensions.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.X509Extension]
- class CaOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes values that are relevant in a CA certificate.
- is_ca¶
Optional. Refers to the “CA” X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.
- max_issuer_path_length¶
Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.
- class google.cloud.security.privateca_v1beta1.types.ReusableConfigWrapper(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [ReusableConfigWrapper][google.cloud.security.privateca.v1beta1.ReusableConfigWrapper] describes values that may assist in creating an X.509 certificate, or a reference to a pre-defined set of values.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- reusable_config¶
Required. A resource path to a [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] in the format
projects/*/locations/*/reusableConfigs/*.This field is a member of oneof
config_values.- Type
- class google.cloud.security.privateca_v1beta1.types.RevocationReason(value)[source]¶
Bases:
proto.enums.EnumA [RevocationReason][google.cloud.security.privateca.v1beta1.RevocationReason] indicates whether a [Certificate][google.cloud.security.privateca.v1beta1.Certificate] has been revoked, and the reason for revocation. These correspond to standard revocation reasons from RFC 5280. Note that the enum labels and values in this definition are not the same ASN.1 values defined in RFC 5280. These values will be translated to the correct ASN.1 values when a CRL is created.
- Values:
- REVOCATION_REASON_UNSPECIFIED (0):
Default unspecified value. This value does indicate that a [Certificate][google.cloud.security.privateca.v1beta1.Certificate] has been revoked, but that a reason has not been recorded.
- KEY_COMPROMISE (1):
Key material for this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] may have leaked.
- CERTIFICATE_AUTHORITY_COMPROMISE (2):
The key material for a certificate authority in the issuing path may have leaked.
- AFFILIATION_CHANGED (3):
The subject or other attributes in this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] have changed.
- SUPERSEDED (4):
This [Certificate][google.cloud.security.privateca.v1beta1.Certificate] has been superseded.
- CESSATION_OF_OPERATION (5):
This [Certificate][google.cloud.security.privateca.v1beta1.Certificate] or entities in the issuing path have ceased to operate.
- CERTIFICATE_HOLD (6):
This [Certificate][google.cloud.security.privateca.v1beta1.Certificate] should not be considered valid, it is expected that it may become valid in the future.
- PRIVILEGE_WITHDRAWN (7):
This [Certificate][google.cloud.security.privateca.v1beta1.Certificate] no longer has permission to assert the listed attributes.
- ATTRIBUTE_AUTHORITY_COMPROMISE (8):
The authority which determines appropriate attributes for a [Certificate][google.cloud.security.privateca.v1beta1.Certificate] may have been compromised.
- class google.cloud.security.privateca_v1beta1.types.RevokeCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.RevokeCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RevokeCertificate].
- name¶
Required. The resource name for this [Certificate][google.cloud.security.privateca.v1beta1.Certificate] in the format
projects/*/locations/*/certificateAuthorities/*/certificates/*.- Type
- reason¶
Required. The [RevocationReason][google.cloud.security.privateca.v1beta1.RevocationReason] for revoking this certificate.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.ScheduleDeleteCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ScheduleDeleteCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ScheduleDeleteCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the format
projects/*/locations/*/certificateAuthorities/*.- Type
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.Subject(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[Subject][google.cloud.security.privateca.v1beta1.Subject] describes parts of a distinguished name that, in turn, describes the subject of the certificate.
- class google.cloud.security.privateca_v1beta1.types.SubjectAltNames(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[SubjectAltNames][google.cloud.security.privateca.v1beta1.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).
- ip_addresses¶
Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.
- Type
MutableSequence[str]
- custom_sans¶
Contains additional subject alternative name values.
- Type
MutableSequence[google.cloud.security.privateca_v1beta1.types.X509Extension]
- class google.cloud.security.privateca_v1beta1.types.SubordinateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a subordinate CA’s issuers. This is either a resource path to a known issuing [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], or a PEM issuer certificate chain.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- certificate_authority¶
Required. This can refer to a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] in the same project that was used to create a subordinate [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. This field is used for information and usability purposes only. The resource name is in the format
projects/*/locations/*/certificateAuthorities/*.This field is a member of oneof
subordinate_config.- Type
- pem_issuer_chain¶
Required. Contains the PEM certificate chain for the issuers of this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], but not pem certificate for this CA itself.
This field is a member of oneof
subordinate_config.
- class SubordinateConfigChain(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis message describes a subordinate CA’s issuer certificate chain. This wrapper exists for compatibility reasons.
- class google.cloud.security.privateca_v1beta1.types.UpdateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateAuthority].
- certificate_authority¶
Required. [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] with updated values.
- update_mask¶
Required. A list of fields to be updated in this request.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.UpdateCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificate].
- certificate¶
Required. [Certificate][google.cloud.security.privateca.v1beta1.Certificate] with updated values.
- update_mask¶
Required. A list of fields to be updated in this request.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.UpdateCertificateRevocationListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateRevocationList].
- certificate_revocation_list¶
Required. [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] with updated values.
- update_mask¶
Required. A list of fields to be updated in this request.
- request_id¶
Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.security.privateca_v1beta1.types.X509Extension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn [X509Extension][google.cloud.security.privateca.v1beta1.X509Extension] specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.
- object_id¶
Required. The OID for this X.509 extension.
- critical¶
Required. 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).
- Type
