API documentation for privateca_v1beta1.types package.
Classes
ActivateCertificateAuthorityRequest
Request message for CertificateAuthorityService.ActivateCertificateAuthority.
Certificate
A Certificate corresponds to a signed X.509 certificate issued by a 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CertificateAuthority
A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.
CertificateConfig
A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.
CertificateDescription
A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.
CertificateRevocationList
A 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.
CreateCertificateAuthorityRequest
Request message for CertificateAuthorityService.CreateCertificateAuthority.
CreateCertificateRequest
Request message for CertificateAuthorityService.CreateCertificate.
DisableCertificateAuthorityRequest
Request message for CertificateAuthorityService.DisableCertificateAuthority.
EnableCertificateAuthorityRequest
Request message for CertificateAuthorityService.EnableCertificateAuthority.
FetchCertificateAuthorityCsrRequest
Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr.
FetchCertificateAuthorityCsrResponse
Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.
GetCertificateAuthorityRequest
Request message for CertificateAuthorityService.GetCertificateAuthority.
GetCertificateRequest
Request message for CertificateAuthorityService.GetCertificate.
GetCertificateRevocationListRequest
Request message for CertificateAuthorityService.GetCertificateRevocationList.
GetReusableConfigRequest
Request message for CertificateAuthorityService.GetReusableConfig.
KeyUsage
A KeyUsage describes key usage values that may appear in an X.509 certificate.
ListCertificateAuthoritiesRequest
Request message for CertificateAuthorityService.ListCertificateAuthorities.
ListCertificateAuthoritiesResponse
Response message for CertificateAuthorityService.ListCertificateAuthorities.
ListCertificateRevocationListsRequest
Request message for CertificateAuthorityService.ListCertificateRevocationLists.
ListCertificateRevocationListsResponse
Response message for CertificateAuthorityService.ListCertificateRevocationLists.
ListCertificatesRequest
Request message for CertificateAuthorityService.ListCertificates.
ListCertificatesResponse
Response message for CertificateAuthorityService.ListCertificates.
ListReusableConfigsRequest
Request message for CertificateAuthorityService.ListReusableConfigs.
ListReusableConfigsResponse
Response message for CertificateAuthorityService.ListReusableConfigs.
ObjectId
An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.
OperationMetadata
Represents the metadata of the long-running operation.
PublicKey
A PublicKey describes a public key.
RestoreCertificateAuthorityRequest
Request message for CertificateAuthorityService.RestoreCertificateAuthority.
ReusableConfig
A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.
ReusableConfigValues
A ReusableConfigValues is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.
ReusableConfigWrapper
A ReusableConfigWrapper describes values that may assist in creating an X.509 certificate, or a reference to a pre-defined set of values.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RevocationReason
A RevocationReason indicates whether a 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 has been revoked, but that a reason has not been recorded. KEY_COMPROMISE (1): Key material for this 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 have changed. SUPERSEDED (4): This Certificate has been superseded. CESSATION_OF_OPERATION (5): This Certificate or entities in the issuing path have ceased to operate. CERTIFICATE_HOLD (6): This Certificate should not be considered valid, it is expected that it may become valid in the future. PRIVILEGE_WITHDRAWN (7): This Certificate no longer has permission to assert the listed attributes. ATTRIBUTE_AUTHORITY_COMPROMISE (8): The authority which determines appropriate attributes for a Certificate may have been compromised.
RevokeCertificateRequest
Request message for CertificateAuthorityService.RevokeCertificate.
ScheduleDeleteCertificateAuthorityRequest
Request message for CertificateAuthorityService.ScheduleDeleteCertificateAuthority.
Subject
Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.
SubjectAltNames
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).
SubordinateConfig
Describes a subordinate CA's issuers. This is either a resource path to a known issuing 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateCertificateAuthorityRequest
Request message for CertificateAuthorityService.UpdateCertificateAuthority.
UpdateCertificateRequest
Request message for CertificateAuthorityService.UpdateCertificate.
UpdateCertificateRevocationListRequest
Request message for CertificateAuthorityService.UpdateCertificateRevocationList.
X509Extension
An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.