Certificate Authority v1beta1 API - Namespace Google.Cloud.Security.PrivateCA.V1Beta1 (2.0.0-beta02)

Classes

ActivateCertificateAuthorityRequest

Request message for [CertificateAuthorityService.ActivateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ActivateCertificateAuthority].

Certificate

A [Certificate][google.cloud.security.privateca.v1beta1.Certificate] corresponds to a signed X.509 certificate issued by a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].

Certificate.Types

Container for nested types declared in the Certificate message type.

Certificate.Types.RevocationDetails

Describes fields that are relavent to the revocation of a [Certificate][google.cloud.security.privateca.v1beta1.Certificate].

CertificateAuthority

A [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] represents an individual Certificate Authority. A [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] can be used to create [Certificates][google.cloud.security.privateca.v1beta1.Certificate].

CertificateAuthority.Types

Container for nested types declared in the CertificateAuthority message type.

CertificateAuthority.Types.AccessUrls

URLs where a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will publish content.

CertificateAuthority.Types.CertificateAuthorityPolicy

The issuing policy for a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority]. [Certificates][google.cloud.security.privateca.v1beta1.Certificate] will not be successfully issued from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] if they violate the policy.

CertificateAuthority.Types.CertificateAuthorityPolicy.Types

Container for nested types declared in the CertificateAuthorityPolicy message type.

CertificateAuthority.Types.CertificateAuthorityPolicy.Types.AllowedConfigList

CertificateAuthority.Types.CertificateAuthorityPolicy.Types.AllowedSubjectAltNames

[AllowedSubjectAltNames][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames] specifies the allowed values for [SubjectAltNames][google.cloud.security.privateca.v1beta1.SubjectAltNames] by the [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] when issuing [Certificates][google.cloud.security.privateca.v1beta1.Certificate].

CertificateAuthority.Types.CertificateAuthorityPolicy.Types.IssuanceModes

[IssuanceModes][google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes] specifies the allowed ways in which [Certificates][google.cloud.security.privateca.v1beta1.Certificate] may be requested from this [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].

CertificateAuthority.Types.IssuingOptions

Options that affect all certificates issued by a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority].

CertificateAuthority.Types.KeyVersionSpec

A Cloud KMS key configuration that a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority] will use.

CertificateAuthorityName

Resource name for the CertificateAuthority resource.

CertificateAuthorityService

[Certificate Authority Service][google.cloud.security.privateca.v1beta1.CertificateAuthorityService] manages private certificate authorities and issued certificates.

CertificateAuthorityService.CertificateAuthorityServiceBase

Base class for server-side implementations of CertificateAuthorityService

CertificateAuthorityService.CertificateAuthorityServiceClient

Client for CertificateAuthorityService

CertificateAuthorityServiceClient

CertificateAuthorityService client wrapper, for convenient use.

CertificateAuthorityServiceClientBuilder

Builder class for CertificateAuthorityServiceClient to provide simple configuration of credentials, endpoint etc.

CertificateAuthorityServiceClientImpl

CertificateAuthorityService client wrapper implementation, for convenient use.

CertificateAuthorityServiceSettings

Settings for CertificateAuthorityServiceClient instances.

CertificateConfig

A [CertificateConfig][google.cloud.security.privateca.v1beta1.CertificateConfig] describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.

CertificateConfig.Types

Container for nested types declared in the CertificateConfig message type.

CertificateConfig.Types.SubjectConfig

These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.

CertificateDescription

A [CertificateDescription][google.cloud.security.privateca.v1beta1.CertificateDescription] describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

CertificateDescription.Types

Container for nested types declared in the CertificateDescription message type.

CertificateDescription.Types.CertificateFingerprint

A group of fingerprints for the x509 certificate.

CertificateDescription.Types.KeyId

A KeyId identifies a specific public key, usually by hashing the public key.

CertificateDescription.Types.SubjectDescription

These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.

CertificateName

Resource name for the Certificate resource.

CertificateRevocationList

A [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList] corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.

CertificateRevocationList.Types

Container for nested types declared in the CertificateRevocationList message type.

CertificateRevocationList.Types.RevokedCertificate

Describes a revoked [Certificate][google.cloud.security.privateca.v1beta1.Certificate].

CertificateRevocationListName

Resource name for the CertificateRevocationList resource.

CreateCertificateAuthorityRequest

Request message for [CertificateAuthorityService.CreateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificateAuthority].

CreateCertificateRequest

Request message for [CertificateAuthorityService.CreateCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.CreateCertificate].

DisableCertificateAuthorityRequest

Request message for [CertificateAuthorityService.DisableCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.DisableCertificateAuthority].

EnableCertificateAuthorityRequest

Request message for [CertificateAuthorityService.EnableCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.EnableCertificateAuthority].

FetchCertificateAuthorityCsrRequest

Request message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsr].

FetchCertificateAuthorityCsrResponse

Response message for [CertificateAuthorityService.FetchCertificateAuthorityCsr][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.FetchCertificateAuthorityCsr].

GetCertificateAuthorityRequest

Request message for [CertificateAuthorityService.GetCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateAuthority].

GetCertificateRequest

Request message for [CertificateAuthorityService.GetCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificate].

GetCertificateRevocationListRequest

Request message for [CertificateAuthorityService.GetCertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetCertificateRevocationList].

GetReusableConfigRequest

Request message for [CertificateAuthorityService.GetReusableConfig][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.GetReusableConfig].

KeyUsage

A [KeyUsage][google.cloud.security.privateca.v1beta1.KeyUsage] describes key usage values that may appear in an X.509 certificate.

KeyUsage.Types

Container for nested types declared in the KeyUsage message type.

KeyUsage.Types.ExtendedKeyUsageOptions

[KeyUsage.ExtendedKeyUsageOptions][google.cloud.security.privateca.v1beta1.KeyUsage.ExtendedKeyUsageOptions] has fields that correspond to certain common OIDs that could be specified as an extended key usage value.

KeyUsage.Types.KeyUsageOptions

[KeyUsage.KeyUsageOptions][google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions] corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.

ListCertificateAuthoritiesRequest

Request message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthorities].

ListCertificateAuthoritiesResponse

Response message for [CertificateAuthorityService.ListCertificateAuthorities][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateAuthorities].

ListCertificateRevocationListsRequest

Request message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationLists].

ListCertificateRevocationListsResponse

Response message for [CertificateAuthorityService.ListCertificateRevocationLists][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificateRevocationLists].

ListCertificatesRequest

Request message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificates].

ListCertificatesResponse

Response message for [CertificateAuthorityService.ListCertificates][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListCertificates].

ListReusableConfigsRequest

Request message for [CertificateAuthorityService.ListReusableConfigs][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigs].

ListReusableConfigsResponse

Response message for [CertificateAuthorityService.ListReusableConfigs][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ListReusableConfigs].

ObjectId

An [ObjectId][google.cloud.security.privateca.v1beta1.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][google.cloud.security.privateca.v1beta1.PublicKey] describes a public key.

PublicKey.Types

Container for nested types declared in the PublicKey message type.

RestoreCertificateAuthorityRequest

Request message for [CertificateAuthorityService.RestoreCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RestoreCertificateAuthority].

ReusableConfig

A [ReusableConfig][google.cloud.security.privateca.v1beta1.ReusableConfig] refers to a managed [ReusableConfigValues][google.cloud.security.privateca.v1beta1.ReusableConfigValues]. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

ReusableConfigName

Resource name for the ReusableConfig resource.

ReusableConfigValues

A [ReusableConfigValues][google.cloud.security.privateca.v1beta1.ReusableConfigValues] is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

ReusableConfigValues.Types

Container for nested types declared in the ReusableConfigValues message type.

ReusableConfigValues.Types.CaOptions

Describes values that are relevant in a CA certificate.

ReusableConfigWrapper

A [ReusableConfigWrapper][google.cloud.security.privateca.v1beta1.ReusableConfigWrapper] describes values that may assist in creating an X.509 certificate, or a reference to a pre-defined set of values.

RevokeCertificateRequest

Request message for [CertificateAuthorityService.RevokeCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.RevokeCertificate].

ScheduleDeleteCertificateAuthorityRequest

Request message for [CertificateAuthorityService.ScheduleDeleteCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.ScheduleDeleteCertificateAuthority].

Subject

[Subject][google.cloud.security.privateca.v1beta1.Subject] describes parts of a distinguished name that, in turn, describes the subject of the certificate.

SubjectAltNames

[SubjectAltNames][google.cloud.security.privateca.v1beta1.SubjectAltNames] corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name).

SubordinateConfig

Describes a subordinate CA's issuers. This is either a resource path to a known issuing [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], or a PEM issuer certificate chain.

SubordinateConfig.Types

Container for nested types declared in the SubordinateConfig message type.

SubordinateConfig.Types.SubordinateConfigChain

This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.

UpdateCertificateAuthorityRequest

Request message for [CertificateAuthorityService.UpdateCertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateAuthority].

UpdateCertificateRequest

Request message for [CertificateAuthorityService.UpdateCertificate][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificate].

UpdateCertificateRevocationListRequest

Request message for [CertificateAuthorityService.UpdateCertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateAuthorityService.UpdateCertificateRevocationList].

X509Extension

An [X509Extension][google.cloud.security.privateca.v1beta1.X509Extension] specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

Enums

Certificate.CertificateConfigOneofCase

Enum of possible cases for the "certificate_config" oneof.

CertificateAuthority.Types.CertificateAuthorityPolicy.ConfigPolicyOneofCase

Enum of possible cases for the "config_policy" oneof.

CertificateAuthority.Types.KeyVersionSpec.KeyVersionOneofCase

Enum of possible cases for the "KeyVersion" oneof.

CertificateAuthority.Types.SignHashAlgorithm

The algorithm of a Cloud KMS CryptoKeyVersion of a [CryptoKey][google.cloud.kms.v1.CryptoKey] with the [CryptoKeyPurpose][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] value ASYMMETRIC_SIGN. These values correspond to the [CryptoKeyVersionAlgorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] values. For RSA signing algorithms, the PSS algorithms should be preferred, use PKCS1 algorithms if required for compatibility. For further recommandations, see https://cloud.google.com/kms/docs/algorithms#algorithm_recommendations.

CertificateAuthority.Types.State

The state of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating if it can be used.

CertificateAuthority.Types.Tier

The tier of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating its supported functionality and/or billing SKU.

CertificateAuthority.Types.Type

The type of a [CertificateAuthority][google.cloud.security.privateca.v1beta1.CertificateAuthority], indicating its issuing chain.

CertificateAuthorityName.ResourceNameType

The possible contents of CertificateAuthorityName.

CertificateName.ResourceNameType

The possible contents of CertificateName.

CertificateRevocationList.Types.State

The state of a [CertificateRevocationList][google.cloud.security.privateca.v1beta1.CertificateRevocationList], indicating if it is current.

CertificateRevocationListName.ResourceNameType

The possible contents of CertificateRevocationListName.

PublicKey.Types.KeyType

Types of public keys that are supported. At a minimum, we support RSA and ECDSA, for the key sizes or curves listed: https://cloud.google.com/kms/docs/algorithms#asymmetric_signing_algorithms

ReusableConfigName.ResourceNameType

The possible contents of ReusableConfigName.

ReusableConfigWrapper.ConfigValuesOneofCase

Enum of possible cases for the "config_values" oneof.

RevocationReason

A [RevocationReason][google.cloud.security.privateca.v1beta1.RevocationReason] indicates whether a [Certificate][google.cloud.security.privateca.v1beta1.Certificate] has been revoked, and the reason for revocation. These correspond to standard revocation reasons from RFC 5280. Note that the enum labels and values in this definition are not the same ASN.1 values defined in RFC 5280. These values will be translated to the correct ASN.1 values when a CRL is created.

SubordinateConfig.SubordinateConfigOneofCase

Enum of possible cases for the "subordinate_config" oneof.