Types for Google Cloud Security Privateca v1 API¶
- class google.cloud.security.privateca_v1.types.ActivateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ActivateCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.ActivateCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.- Type
- pem_ca_certificate¶
Required. The signed CA certificate issued from [FetchCertificateAuthorityCsrResponse.pem_csr][google.cloud.security.privateca.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.CaPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CaPool][google.cloud.security.privateca.v1.CaPool] represents a group of [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority] that form a trust anchor. A [CaPool][google.cloud.security.privateca.v1.CaPool] can be used to manage issuance policies for one or more [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] resources and to rotate CA certificates in and out of the trust anchor.
- name¶
Output only. The resource name for this [CaPool][google.cloud.security.privateca.v1.CaPool] in the format
projects/*/locations/*/caPools/*.- Type
- tier¶
Required. Immutable. The [Tier][google.cloud.security.privateca.v1.CaPool.Tier] of this [CaPool][google.cloud.security.privateca.v1.CaPool].
- issuance_policy¶
Optional. The [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy] to control how [Certificates][google.cloud.security.privateca.v1.Certificate] will be issued from this [CaPool][google.cloud.security.privateca.v1.CaPool].
- publishing_options¶
Optional. The [PublishingOptions][google.cloud.security.privateca.v1.CaPool.PublishingOptions] to follow when issuing [Certificates][google.cloud.security.privateca.v1.Certificate] from any [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in this [CaPool][google.cloud.security.privateca.v1.CaPool].
- class IssuancePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines controls over all certificate issuance within a [CaPool][google.cloud.security.privateca.v1.CaPool].
- allowed_key_types¶
Optional. If any [AllowedKeyType][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType] is specified, then the certificate request’s public key must match one of the key types listed here. Otherwise, any key may be used.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.CaPool.IssuancePolicy.AllowedKeyType]
- maximum_lifetime¶
Optional. The maximum lifetime allowed for issued [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that if the issuing [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] expires before a [Certificate][google.cloud.security.privateca.v1.Certificate] resource’s requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
- allowed_issuance_modes¶
Optional. If specified, then only methods allowed in the [IssuanceModes][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.IssuanceModes] may be used to issue [Certificates][google.cloud.security.privateca.v1.Certificate].
- baseline_values¶
Optional. A set of X.509 values that will be applied to all certificates issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] that defines conflicting [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values] for the same properties, the certificate issuance request will fail.
- identity_constraints¶
Optional. Describes constraints on identities that may appear in [Certificates][google.cloud.security.privateca.v1.Certificate] issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If this is omitted, then this [CaPool][google.cloud.security.privateca.v1.CaPool] will not add restrictions on a certificate’s identity.
- passthrough_extensions¶
Optional. Describes the set of X.509 extensions that may appear in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If a certificate request sets extensions that don’t appear in the [passthrough_extensions][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.passthrough_extensions], those extensions will be dropped. If a certificate request uses a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] with [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values] that don’t appear here, the certificate issuance request will fail. If this is omitted, then this [CaPool][google.cloud.security.privateca.v1.CaPool] will not add restrictions on a certificate’s X.509 extensions. These constraints do not apply to X.509 extensions set in this [CaPool][google.cloud.security.privateca.v1.CaPool]’s [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values].
- class AllowedKeyType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a “type” of key that may be used in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued from a [CaPool][google.cloud.security.privateca.v1.CaPool]. Note that a single [AllowedKeyType][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType] may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key.
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.
- elliptic_curve¶
Represents an allowed Elliptic Curve key type.
This field is a member of oneof
key_type.
- class EcKeyType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes an Elliptic Curve key that may be used in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued from a [CaPool][google.cloud.security.privateca.v1.CaPool].
- signature_algorithm¶
Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed.
- class EcSignatureAlgorithm(value)[source]¶
Bases:
proto.enums.EnumDescribes an elliptic curve-based signature algorithm that may be used in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued from a [CaPool][google.cloud.security.privateca.v1.CaPool].
- Values:
- EC_SIGNATURE_ALGORITHM_UNSPECIFIED (0):
Not specified. Signifies that any signature algorithm may be used.
- ECDSA_P256 (1):
Refers to the Elliptic Curve Digital Signature Algorithm over the NIST P-256 curve.
- ECDSA_P384 (2):
Refers to the Elliptic Curve Digital Signature Algorithm over the NIST P-384 curve.
- EDDSA_25519 (3):
Refers to the Edwards-curve Digital Signature Algorithm over curve 25519, as described in RFC 8410.
- class RsaKeyType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes an RSA key that may be used in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued from a [CaPool][google.cloud.security.privateca.v1.CaPool].
- min_modulus_size¶
Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply.
- Type
- class IssuanceModes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[IssuanceModes][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.IssuanceModes] specifies the allowed ways in which [Certificates][google.cloud.security.privateca.v1.Certificate] may be requested from this [CaPool][google.cloud.security.privateca.v1.CaPool].
- allow_csr_based_issuance¶
Optional. When true, allows callers to create [Certificates][google.cloud.security.privateca.v1.Certificate] by specifying a CSR.
- Type
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class PublishingOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions relating to the publication of each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate and CRLs and their inclusion as extensions in issued [Certificates][google.cloud.security.privateca.v1.Certificate]. The options set here apply to certificates issued by any [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the [CaPool][google.cloud.security.privateca.v1.CaPool].
- publish_ca_cert¶
Optional. When true, publishes each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate and includes its URL in the “Authority Information Access” X.509 extension in all issued [Certificates][google.cloud.security.privateca.v1.Certificate]. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates.
- Type
- publish_crl¶
Optional. When true, publishes each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CRL and includes its URL in the “CRL Distribution Points” X.509 extension in all issued [Certificates][google.cloud.security.privateca.v1.Certificate]. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked.
- Type
- encoding_format¶
Optional. Specifies the encoding format of each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] resource’s CA certificate and CRLs. If this is omitted, CA certificates and CRLs will be published in PEM.
- class EncodingFormat(value)[source]¶
Bases:
proto.enums.EnumSupported encoding formats for publishing.
- Values:
- ENCODING_FORMAT_UNSPECIFIED (0):
Not specified. By default, PEM format will be used.
- PEM (1):
The [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate and CRLs will be published in PEM format.
- DER (2):
The [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate and CRLs will be published in DER format.
- class Tier(value)[source]¶
Bases:
proto.enums.EnumThe tier of a [CaPool][google.cloud.security.privateca.v1.CaPool], indicating its supported functionality and/or billing SKU.
- Values:
- TIER_UNSPECIFIED (0):
Not specified.
- ENTERPRISE (1):
Enterprise tier.
- DEVOPS (2):
DevOps tier.
- class google.cloud.security.privateca_v1.types.Certificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [Certificate][google.cloud.security.privateca.v1.Certificate] corresponds to a signed X.509 certificate issued by a [CertificateAuthority][google.cloud.security.privateca.v1.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 name for this [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
projects/*/locations/*/caPools/*/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.
- issuer_certificate_authority¶
Output only. The resource name of the issuing [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.- Type
- 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.
- certificate_template¶
Immutable. The resource name for a [CertificateTemplate][google.cloud.security.privateca.v1.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][google.cloud.security.privateca.v1.Certificate].- Type
- subject_mode¶
Immutable. Specifies how the [Certificate][google.cloud.security.privateca.v1.Certificate]’s identity fields are to be decided. If this is omitted, the
DEFAULTsubject mode will be used.
- revocation_details¶
Output only. Details regarding the revocation of this [Certificate][google.cloud.security.privateca.v1.Certificate]. This [Certificate][google.cloud.security.privateca.v1.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.v1.Certificate] was created.
- update_time¶
Output only. The time at which this [Certificate][google.cloud.security.privateca.v1.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.v1.Certificate].
- revocation_state¶
Indicates why a [Certificate][google.cloud.security.privateca.v1.Certificate] was revoked.
- revocation_time¶
The time at which this [Certificate][google.cloud.security.privateca.v1.Certificate] was revoked.
- class google.cloud.security.privateca_v1.types.CertificateAuthority(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] represents an individual Certificate Authority. A [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] can be used to create [Certificates][google.cloud.security.privateca.v1.Certificate].
- name¶
Output only. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.- Type
- type_¶
Required. Immutable. The [Type][google.cloud.security.privateca.v1.CertificateAuthority.Type] of this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
- config¶
Required. Immutable. The config used to create a self-signed X.509 certificate or CSR.
- lifetime¶
Required. Immutable. 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.v1.CertificateAuthority]. If this [CertificateAuthority][google.cloud.security.privateca.v1.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.
- subordinate_config¶
Optional. If this is a subordinate [CertificateAuthority][google.cloud.security.privateca.v1.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.v1.CertificateAuthority] must continue to validate.
- tier¶
Output only. The [CaPool.Tier][google.cloud.security.privateca.v1.CaPool.Tier] of the [CaPool][google.cloud.security.privateca.v1.CaPool] that includes this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
- state¶
Output only. The [State][google.cloud.security.privateca.v1.CertificateAuthority.State] for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority].
- pem_ca_certificates¶
Output only. This [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s certificate chain, including the current [CertificateAuthority][google.cloud.security.privateca.v1.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.v1.CertificateAuthority]’s certificate.
- Type
MutableSequence[str]
- ca_certificate_descriptions¶
Output only. A structured description of this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate and its issuers. Ordered as self-to-root.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.CertificateDescription]
- gcs_bucket¶
Immutable. The name of a Cloud Storage bucket where this [CertificateAuthority][google.cloud.security.privateca.v1.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.v1.CertificateAuthority] was created.
- update_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] was last updated.
- delete_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] was soft deleted, if it is in the [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED] state.
- expire_time¶
Output only. The time at which this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] will be permanently purged, if it is in the [DELETED][google.cloud.security.privateca.v1.CertificateAuthority.State.DELETED] state.
- class AccessUrls(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageURLs where a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] will publish content.
- ca_certificate_access_url¶
The URL where this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]’s CA certificate is published. This will only be set for CAs that have been activated.
- 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.v1.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¶
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 recommendations, 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.v1.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. The CA will be part of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s trust anchor, and will be used to issue certificates from the [CaPool][google.cloud.security.privateca.v1.CaPool].
- DISABLED (2):
Certificates cannot be issued from this CA. CRLs will still be generated. The CA will be part of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s trust anchor, but will not be used to issue certificates from the [CaPool][google.cloud.security.privateca.v1.CaPool].
- STAGED (3):
Certificates can be issued from this CA. CRLs will be generated for this CA. The CA will be part of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s trust anchor, but will not be used to issue certificates from the [CaPool][google.cloud.security.privateca.v1.CaPool].
- AWAITING_USER_ACTIVATION (4):
Certificates cannot be issued from this CA. CRLs will not be generated. The CA will not be part of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s trust anchor, and will not be used to issue certificates from the [CaPool][google.cloud.security.privateca.v1.CaPool].
- DELETED (5):
Certificates cannot be issued from this CA. CRLs will not be generated. The CA may still be recovered by calling [CertificateAuthorityService.UndeleteCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.UndeleteCertificateAuthority] before [expire_time][google.cloud.security.privateca.v1.CertificateAuthority.expire_time]. The CA will not be part of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s trust anchor, and will not be used to issue certificates from the [CaPool][google.cloud.security.privateca.v1.CaPool].
- class Type(value)[source]¶
Bases:
proto.enums.EnumThe type of a [CertificateAuthority][google.cloud.security.privateca.v1.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.v1.CertificateAuthority] or an unmanaged CA.
- class google.cloud.security.privateca_v1.types.CertificateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateConfig][google.cloud.security.privateca.v1.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.
- x509_config¶
Required. Describes how some of the technical X.509 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.v1.Certificate], but not when creating a self-signed [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] or [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] CSR.
- subject_key_id¶
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.
- 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 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¶
Optional. Contains distinguished name fields such as the common name, location and organization.
- subject_alt_name¶
Optional. The subject alternative name fields.
- class google.cloud.security.privateca_v1.types.CertificateDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateDescription][google.cloud.security.privateca.v1.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.
- x509_description¶
Describes some of the technical X.509 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 common name, location and / organization.
- subject_alt_name¶
The subject alternative name fields.
- lifetime¶
For convenience, the actual lifetime of an issued certificate.
- not_before_time¶
The time at which the certificate becomes valid.
- not_after_time¶
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.
- class google.cloud.security.privateca_v1.types.CertificateExtensionConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a set of X.509 extensions that may be part of some certificate issuance controls.
- known_extensions¶
Optional. A set of named X.509 extensions. Will be combined with [additional_extensions][google.cloud.security.privateca.v1.CertificateExtensionConstraints.additional_extensions] to determine the full set of X.509 extensions.
- additional_extensions¶
Optional. A set of [ObjectIds][google.cloud.security.privateca.v1.ObjectId] identifying custom X.509 extensions. Will be combined with [known_extensions][google.cloud.security.privateca.v1.CertificateExtensionConstraints.known_extensions] to determine the full set of X.509 extensions.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.ObjectId]
- class KnownCertificateExtension(value)[source]¶
Bases:
proto.enums.EnumDescribes well-known X.509 extensions that can appear in a [Certificate][google.cloud.security.privateca.v1.Certificate], not including the [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] extension.
- Values:
- KNOWN_CERTIFICATE_EXTENSION_UNSPECIFIED (0):
Not specified.
- BASE_KEY_USAGE (1):
Refers to a certificate’s Key Usage extension, as described in RFC 5280 section 4.2.1.3. This corresponds to the [KeyUsage.base_key_usage][google.cloud.security.privateca.v1.KeyUsage.base_key_usage] field.
- EXTENDED_KEY_USAGE (2):
Refers to a certificate’s Extended Key Usage extension, as described in RFC 5280 section 4.2.1.12. This corresponds to the [KeyUsage.extended_key_usage][google.cloud.security.privateca.v1.KeyUsage.extended_key_usage] message.
- CA_OPTIONS (3):
Refers to a certificate’s Basic Constraints extension, as described in RFC 5280 section 4.2.1.9. This corresponds to the [X509Parameters.ca_options][google.cloud.security.privateca.v1.X509Parameters.ca_options] field.
- POLICY_IDS (4):
Refers to a certificate’s Policy object identifiers, as described in RFC 5280 section 4.2.1.4. This corresponds to the [X509Parameters.policy_ids][google.cloud.security.privateca.v1.X509Parameters.policy_ids] field.
- AIA_OCSP_SERVERS (5):
Refers to OCSP servers in a certificate’s Authority Information Access extension, as described in RFC 5280 section 4.2.2.1, This corresponds to the [X509Parameters.aia_ocsp_servers][google.cloud.security.privateca.v1.X509Parameters.aia_ocsp_servers] field.
- NAME_CONSTRAINTS (6):
Refers to Name Constraints extension as described in RFC 5280 section 4.2.1.10
- class google.cloud.security.privateca_v1.types.CertificateIdentityConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes constraints on a [Certificate][google.cloud.security.privateca.v1.Certificate]’s [Subject][google.cloud.security.privateca.v1.Subject] and [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames].
- cel_expression¶
Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel
- Type
google.type.expr_pb2.Expr
- allow_subject_passthrough¶
Required. If this is true, the [Subject][google.cloud.security.privateca.v1.Subject] field may be copied from a certificate request into the signed certificate. Otherwise, the requested [Subject][google.cloud.security.privateca.v1.Subject] will be discarded.
This field is a member of oneof
_allow_subject_passthrough.- Type
- allow_subject_alt_names_passthrough¶
Required. If this is true, the [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] extension may be copied from a certificate request into the signed certificate. Otherwise, the requested [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] will be discarded.
This field is a member of oneof
_allow_subject_alt_names_passthrough.- Type
- class google.cloud.security.privateca_v1.types.CertificateRevocationList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateRevocationList][google.cloud.security.privateca.v1.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 name for this [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList] in the format
projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*.- Type
- revoked_certificates¶
Output only. The revoked serial numbers that appear in pem_crl.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.CertificateRevocationList.RevokedCertificate]
- state¶
Output only. The [State][google.cloud.security.privateca.v1.CertificateRevocationList.State] for this [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList].
- create_time¶
Output only. The time at which this [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList] was created.
- update_time¶
Output only. The time at which this [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList] was updated.
- revision_id¶
Output only. The revision ID of this [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList]. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string.
- Type
- 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.v1.Certificate].
- certificate¶
The resource name for the [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
projects/*/locations/*/caPools/*/certificates/*.- Type
- hex_serial_number¶
The serial number of the [Certificate][google.cloud.security.privateca.v1.Certificate].
- Type
- revocation_reason¶
The reason the [Certificate][google.cloud.security.privateca.v1.Certificate] was revoked.
- class State(value)[source]¶
Bases:
proto.enums.EnumThe state of a [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList], indicating if it is current.
- Values:
- STATE_UNSPECIFIED (0):
Not specified.
- ACTIVE (1):
The [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList] is up to date.
- SUPERSEDED (2):
The [CertificateRevocationList][google.cloud.security.privateca.v1.CertificateRevocationList] is no longer current.
- class google.cloud.security.privateca_v1.types.CertificateTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] refers to a managed template for certificate issuance.
- name¶
Output only. The resource name for this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] in the format
projects/*/locations/*/certificateTemplates/*.- Type
- maximum_lifetime¶
Optional. The maximum lifetime allowed for issued [Certificates][google.cloud.security.privateca.v1.Certificate] that use this template. If the issuing [CaPool][google.cloud.security.privateca.v1.CaPool] resource’s [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy] specifies a [maximum_lifetime][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.maximum_lifetime] the minimum of the two durations will be the maximum lifetime for issued [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that if the issuing [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] expires before a [Certificate][google.cloud.security.privateca.v1.Certificate]’s requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
- predefined_values¶
Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing [CaPool][google.cloud.security.privateca.v1.CaPool]’s [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy] defines conflicting [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values] for the same properties, the certificate issuance request will fail.
- identity_constraints¶
Optional. Describes constraints on identities that may be appear in [Certificates][google.cloud.security.privateca.v1.Certificate] issued using this template. If this is omitted, then this template will not add restrictions on a certificate’s identity.
- passthrough_extensions¶
Optional. Describes the set of X.509 extensions that may appear in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued using this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]. If a certificate request sets extensions that don’t appear in the [passthrough_extensions][google.cloud.security.privateca.v1.CertificateTemplate.passthrough_extensions], those extensions will be dropped. If the issuing [CaPool][google.cloud.security.privateca.v1.CaPool]’s [IssuancePolicy][google.cloud.security.privateca.v1.CaPool.IssuancePolicy] defines [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values] that don’t appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate’s X.509 extensions. These constraints do not apply to X.509 extensions set in this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]’s [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values].
- description¶
Optional. A human-readable description of scenarios this template is intended for.
- Type
- create_time¶
Output only. The time at which this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] was created.
- update_time¶
Output only. The time at which this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] was updated.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.security.privateca_v1.types.CreateCaPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCaPool][google.cloud.security.privateca.v1.CertificateAuthorityService.CreateCaPool].
- parent¶
Required. The resource name of the location associated with the [CaPool][google.cloud.security.privateca.v1.CaPool], in the format
projects/*/locations/*.- Type
- ca_pool_id¶
Required. It must be unique within a location and match the regular expression
[a-zA-Z0-9_-]{1,63}- Type
- ca_pool¶
Required. A [CaPool][google.cloud.security.privateca.v1.CaPool] 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 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).
- Type
- class google.cloud.security.privateca_v1.types.CreateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.CreateCertificateAuthority].
- parent¶
Required. The resource name of the [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority], in the format
projects/*/locations/*/caPools/*.- 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.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.CreateCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCertificate][google.cloud.security.privateca.v1.CertificateAuthorityService.CreateCertificate].
- parent¶
Required. The resource name of the [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the [Certificate][google.cloud.security.privateca.v1.Certificate], in the format
projects/*/locations/*/caPools/*.- 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.v1.CertificateAuthority] in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise.- Type
- certificate¶
Required. A [Certificate][google.cloud.security.privateca.v1.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 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).
- Type
- validate_only¶
Optional. If this is true, no [Certificate][google.cloud.security.privateca.v1.Certificate] resource will be persisted regardless of the [CaPool][google.cloud.security.privateca.v1.CaPool]’s [tier][google.cloud.security.privateca.v1.CaPool.tier], and the returned [Certificate][google.cloud.security.privateca.v1.Certificate] will not contain the [pem_certificate][google.cloud.security.privateca.v1.Certificate.pem_certificate] field.
- Type
- issuing_certificate_authority_id¶
Optional. The resource ID of the [CertificateAuthority][google.cloud.security.privateca.v1.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][google.cloud.security.privateca.v1.CaPool] referenced by
parent. Per-CA quota rules apply. If left empty, a [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] will be chosen from the [CaPool][google.cloud.security.privateca.v1.CaPool] by the service. For example, to issue a [Certificate][google.cloud.security.privateca.v1.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][google.cloud.security.privateca.v1.CreateCertificateRequest.parent] to “projects/my-project/locations/us-central1/caPools/my-pool” and the [issuing_certificate_authority_id][google.cloud.security.privateca.v1.CreateCertificateRequest.issuing_certificate_authority_id] to “my-ca”.- Type
- class google.cloud.security.privateca_v1.types.CreateCertificateTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.CreateCertificateTemplate][google.cloud.security.privateca.v1.CertificateAuthorityService.CreateCertificateTemplate].
- parent¶
Required. The resource name of the location associated with the [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate], in the format
projects/*/locations/*.- Type
- certificate_template_id¶
Required. It must be unique within a location and match the regular expression
[a-zA-Z0-9_-]{1,63}- Type
- certificate_template¶
Required. A [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] 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 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).
- Type
- class google.cloud.security.privateca_v1.types.DeleteCaPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.DeleteCaPool][google.cloud.security.privateca.v1.CertificateAuthorityService.DeleteCaPool].
- name¶
Required. The resource name for this [CaPool][google.cloud.security.privateca.v1.CaPool] in the format
projects/*/locations/*/caPools/*.- 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 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).
- Type
- class google.cloud.security.privateca_v1.types.DeleteCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.DeleteCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.DeleteCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/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 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).
- Type
- ignore_active_certificates¶
Optional. This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs.
- Type
- skip_grace_period¶
Optional. If this flag is set, the Certificate Authority will be deleted as soon as possible without a 30-day grace period where undeletion would have been allowed. If you proceed, there will be no way to recover this CA.
- Type
- class google.cloud.security.privateca_v1.types.DeleteCertificateTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.DeleteCertificateTemplate][google.cloud.security.privateca.v1.CertificateAuthorityService.DeleteCertificateTemplate].
- name¶
Required. The resource name for this [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] in the format
projects/*/locations/*/certificateTemplates/*.- 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 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).
- Type
- class google.cloud.security.privateca_v1.types.DisableCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.DisableCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.DisableCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/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 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).
- Type
- class google.cloud.security.privateca_v1.types.EnableCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.EnableCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.EnableCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/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 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).
- Type
- class google.cloud.security.privateca_v1.types.FetchCaCertsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.FetchCaCerts][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCaCerts].
- ca_pool¶
Required. The resource name for the [CaPool][google.cloud.security.privateca.v1.CaPool] in the format
projects/*/locations/*/caPools/*.- 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 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).
- Type
- class google.cloud.security.privateca_v1.types.FetchCaCertsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.FetchCaCerts][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCaCerts].
- ca_certs¶
The PEM encoded CA certificate chains of all certificate authorities in this [CaPool][google.cloud.security.privateca.v1.CaPool] in the ENABLED, DISABLED, or STAGED states.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.FetchCaCertsResponse.CertChain]
- class CertChain(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class google.cloud.security.privateca_v1.types.FetchCertificateAuthorityCsrRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCertificateAuthorityCsr].
- class google.cloud.security.privateca_v1.types.FetchCertificateAuthorityCsrResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1.CertificateAuthorityService.FetchCertificateAuthorityCsr].
- class google.cloud.security.privateca_v1.types.GetCaPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCaPool][google.cloud.security.privateca.v1.CertificateAuthorityService.GetCaPool].
- class google.cloud.security.privateca_v1.types.GetCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.GetCertificateAuthority].
- class google.cloud.security.privateca_v1.types.GetCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificate][google.cloud.security.privateca.v1.CertificateAuthorityService.GetCertificate].
- class google.cloud.security.privateca_v1.types.GetCertificateRevocationListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificateRevocationList][google.cloud.security.privateca.v1.CertificateAuthorityService.GetCertificateRevocationList].
- class google.cloud.security.privateca_v1.types.GetCertificateTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.GetCertificateTemplate][google.cloud.security.privateca.v1.CertificateAuthorityService.GetCertificateTemplate].
- class google.cloud.security.privateca_v1.types.KeyUsage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [KeyUsage][google.cloud.security.privateca.v1.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.v1.KeyUsage.ExtendedKeyUsageOptions] message.
- Type
MutableSequence[google.cloud.security.privateca_v1.types.ObjectId]
- class ExtendedKeyUsageOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[KeyUsage.ExtendedKeyUsageOptions][google.cloud.security.privateca.v1.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.v1.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_v1.types.ListCaPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCaPools][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCaPools].
- parent¶
Required. The resource name of the location associated with the [CaPools][google.cloud.security.privateca.v1.CaPool], in the format
projects/*/locations/*.- Type
- page_size¶
Optional. Limit on the number of [CaPools][google.cloud.security.privateca.v1.CaPool] to include in the response. Further [CaPools][google.cloud.security.privateca.v1.CaPool] can subsequently be obtained by including the [ListCaPoolsResponse.next_page_token][google.cloud.security.privateca.v1.ListCaPoolsResponse.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 [ListCaPoolsResponse.next_page_token][google.cloud.security.privateca.v1.ListCaPoolsResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1.types.ListCaPoolsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCaPools][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCaPools].
- ca_pools¶
The list of [CaPools][google.cloud.security.privateca.v1.CaPool].
- Type
MutableSequence[google.cloud.security.privateca_v1.types.CaPool]
- 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_v1.types.ListCertificateAuthoritiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateAuthorities].
- parent¶
Required. The resource name of the [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority], in the format
projects/*/locations/*/caPools/*.- Type
- page_size¶
Optional. Limit on the number of [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority] to include in the response. Further [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority] can subsequently be obtained by including the [ListCertificateAuthoritiesResponse.next_page_token][google.cloud.security.privateca.v1.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.v1.ListCertificateAuthoritiesResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1.types.ListCertificateAuthoritiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateAuthorities].
- certificate_authorities¶
The list of [CertificateAuthorities][google.cloud.security.privateca.v1.CertificateAuthority].
- Type
MutableSequence[google.cloud.security.privateca_v1.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_v1.types.ListCertificateRevocationListsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateRevocationLists].
- parent¶
Required. The resource name of the location associated with the [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList], in the format
projects/*/locations/*/caPools/*/certificateAuthorities/*.- Type
- page_size¶
Optional. Limit on the number of [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList] to include in the response. Further [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList] can subsequently be obtained by including the [ListCertificateRevocationListsResponse.next_page_token][google.cloud.security.privateca.v1.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.v1.ListCertificateRevocationListsResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1.types.ListCertificateRevocationListsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateRevocationLists].
- certificate_revocation_lists¶
The list of [CertificateRevocationLists][google.cloud.security.privateca.v1.CertificateRevocationList].
- Type
MutableSequence[google.cloud.security.privateca_v1.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_v1.types.ListCertificateTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificateTemplates][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateTemplates].
- parent¶
Required. The resource name of the location associated with the [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate], in the format
projects/*/locations/*.- Type
- page_size¶
Optional. Limit on the number of [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate] to include in the response. Further [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate] can subsequently be obtained by including the [ListCertificateTemplatesResponse.next_page_token][google.cloud.security.privateca.v1.ListCertificateTemplatesResponse.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 [ListCertificateTemplatesResponse.next_page_token][google.cloud.security.privateca.v1.ListCertificateTemplatesResponse.next_page_token].
- Type
- class google.cloud.security.privateca_v1.types.ListCertificateTemplatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificateTemplates][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificateTemplates].
- certificate_templates¶
The list of [CertificateTemplates][google.cloud.security.privateca.v1.CertificateTemplate].
- Type
MutableSequence[google.cloud.security.privateca_v1.types.CertificateTemplate]
- next_page_token¶
A token to retrieve next page of results. Pass this value in [ListCertificateTemplatesRequest.next_page_token][] to retrieve the next page of results.
- Type
- class google.cloud.security.privateca_v1.types.ListCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificates].
- parent¶
Required. The resource name of the location associated with the [Certificates][google.cloud.security.privateca.v1.Certificate], in the format
projects/*/locations/*/caPools/*.- Type
- page_size¶
Optional. Limit on the number of [Certificates][google.cloud.security.privateca.v1.Certificate] to include in the response. Further [Certificates][google.cloud.security.privateca.v1.Certificate] can subsequently be obtained by including the [ListCertificatesResponse.next_page_token][google.cloud.security.privateca.v1.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.v1.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_v1.types.ListCertificatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1.CertificateAuthorityService.ListCertificates].
- certificates¶
The list of [Certificates][google.cloud.security.privateca.v1.Certificate].
- Type
MutableSequence[google.cloud.security.privateca_v1.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_v1.types.ObjectId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn [ObjectId][google.cloud.security.privateca.v1.ObjectId] specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
- class google.cloud.security.privateca_v1.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_v1.types.PublicKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA [PublicKey][google.cloud.security.privateca.v1.PublicKey] describes a public key.
- key¶
Required. A public key. The padding and encoding must match with the
KeyFormatvalue specified for theformatfield.- Type
- format_¶
Required. The format of the public key.
- class KeyFormat(value)[source]¶
Bases:
proto.enums.EnumTypes of public keys formats that are supported. Currently, only
PEMformat is supported.- Values:
- KEY_FORMAT_UNSPECIFIED (0):
Default unspecified value.
- PEM (1):
The key is PEM-encoded as defined in RFC 7468. It can be any of the following: a PEM-encoded PKCS#1/RFC 3447 RSAPublicKey structure, an RFC 5280 SubjectPublicKeyInfo or a PEM-encoded X.509 certificate signing request (CSR). If a SubjectPublicKeyInfo is specified, it can contain a A PEM-encoded PKCS#1/RFC 3447 RSAPublicKey or a NIST P-256/secp256r1/prime256v1 or P-384 key. If a CSR is specified, it will used solely for the purpose of extracting the public key. When generated by the service, it will always be an RFC 5280 SubjectPublicKeyInfo structure containing an algorithm identifier and a key.
- class google.cloud.security.privateca_v1.types.RevocationReason(value)[source]¶
Bases:
proto.enums.EnumA [RevocationReason][google.cloud.security.privateca.v1.RevocationReason] indicates whether a [Certificate][google.cloud.security.privateca.v1.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.v1.Certificate] has been revoked, but that a reason has not been recorded.
- KEY_COMPROMISE (1):
Key material for this [Certificate][google.cloud.security.privateca.v1.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.v1.Certificate] have changed.
- SUPERSEDED (4):
This [Certificate][google.cloud.security.privateca.v1.Certificate] has been superseded.
- CESSATION_OF_OPERATION (5):
This [Certificate][google.cloud.security.privateca.v1.Certificate] or entities in the issuing path have ceased to operate.
- CERTIFICATE_HOLD (6):
This [Certificate][google.cloud.security.privateca.v1.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.v1.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.v1.Certificate] may have been compromised.
- class google.cloud.security.privateca_v1.types.RevokeCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.RevokeCertificate][google.cloud.security.privateca.v1.CertificateAuthorityService.RevokeCertificate].
- name¶
Required. The resource name for this [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
projects/*/locations/*/caPools/*/certificates/*.- Type
- reason¶
Required. The [RevocationReason][google.cloud.security.privateca.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.Subject(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[Subject][google.cloud.security.privateca.v1.Subject] describes parts of a distinguished name that, in turn, describes the subject of the certificate.
- class google.cloud.security.privateca_v1.types.SubjectAltNames(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message[SubjectAltNames][google.cloud.security.privateca.v1.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. For each custom_san, the
valuefield must contain an ASN.1 encoded UTF8String.- Type
MutableSequence[google.cloud.security.privateca_v1.types.X509Extension]
- class google.cloud.security.privateca_v1.types.SubjectRequestMode(value)[source]¶
Bases:
proto.enums.EnumDescribes the way in which a [Certificate][google.cloud.security.privateca.v1.Certificate]’s [Subject][google.cloud.security.privateca.v1.Subject] and/or [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] will be resolved.
- Values:
- SUBJECT_REQUEST_MODE_UNSPECIFIED (0):
Not specified.
- DEFAULT (1):
The default mode used in most cases. Indicates that the certificate’s [Subject][google.cloud.security.privateca.v1.Subject] and/or [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] are specified in the certificate request. This mode requires the caller to have the
privateca.certificates.createpermission.- REFLECTED_SPIFFE (2):
A mode reserved for special cases. Indicates that the certificate should have one SPIFFE [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] set by the service based on the caller’s identity. This mode will ignore any explicitly specified [Subject][google.cloud.security.privateca.v1.Subject] and/or [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] in the certificate request. This mode requires the caller to have the
privateca.certificates.createForSelfpermission.
- class google.cloud.security.privateca_v1.types.SubordinateConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a subordinate CA’s issuers. This is either a resource name to a known issuing [CertificateAuthority][google.cloud.security.privateca.v1.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.v1.CertificateAuthority] that was used to create a subordinate [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]. This field is used for information and usability purposes only. The resource name is in the format
projects/*/locations/*/caPools/*/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.v1.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_v1.types.UndeleteCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UndeleteCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.UndeleteCertificateAuthority].
- name¶
Required. The resource name for this [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] in the format
projects/*/locations/*/caPools/*/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 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).
- Type
- class google.cloud.security.privateca_v1.types.UpdateCaPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCaPool][google.cloud.security.privateca.v1.CertificateAuthorityService.UpdateCaPool].
- ca_pool¶
Required. [CaPool][google.cloud.security.privateca.v1.CaPool] 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 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).
- Type
- class google.cloud.security.privateca_v1.types.UpdateCertificateAuthorityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthorityService.UpdateCertificateAuthority].
- certificate_authority¶
Required. [CertificateAuthority][google.cloud.security.privateca.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.UpdateCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificate][google.cloud.security.privateca.v1.CertificateAuthorityService.UpdateCertificate].
- certificate¶
Required. [Certificate][google.cloud.security.privateca.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.UpdateCertificateRevocationListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificateRevocationList][google.cloud.security.privateca.v1.CertificateAuthorityService.UpdateCertificateRevocationList].
- certificate_revocation_list¶
Required. [CertificateRevocationList][google.cloud.security.privateca.v1.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 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).
- Type
- class google.cloud.security.privateca_v1.types.UpdateCertificateTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for [CertificateAuthorityService.UpdateCertificateTemplate][google.cloud.security.privateca.v1.CertificateAuthorityService.UpdateCertificateTemplate].
- certificate_template¶
Required. [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] 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 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).
- Type
- class google.cloud.security.privateca_v1.types.X509Extension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn [X509Extension][google.cloud.security.privateca.v1.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¶
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).
- Type
- class google.cloud.security.privateca_v1.types.X509Parameters(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn [X509Parameters][google.cloud.security.privateca.v1.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.
- key_usage¶
Optional. Indicates the intended use for keys that correspond to a certificate.
- ca_options¶
Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] 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_v1.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]
- name_constraints¶
Optional. Describes the X.509 name constraints extension.
- additional_extensions¶
Optional. Describes custom X.509 extensions.
- Type
MutableSequence[google.cloud.security.privateca_v1.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.
This field is a member of oneof
_is_ca.- Type
- 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.
This field is a member of oneof
_max_issuer_path_length.- Type
- class NameConstraints(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10
- permitted_dns_names¶
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.comwould satisfyexample.comwhileexample1.comdoes not.- Type
MutableSequence[str]
- excluded_dns_names¶
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.comwould satisfyexample.comwhileexample1.comdoes not.- Type
MutableSequence[str]
- permitted_ip_ranges¶
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.
- Type
MutableSequence[str]
- excluded_ip_ranges¶
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.
- Type
MutableSequence[str]
- permitted_email_addresses¶
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.- Type
MutableSequence[str]
- excluded_email_addresses¶
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.- Type
MutableSequence[str]
