Certificate Manager Private CA API, REST: PrivateCa.GenerateCertificateAuthority

Field

Description

folderId

string

Required field. Folder ID where the CA is being created.

parentCertificateAuthorityId

string

Optional. If set intermediate CA would be generated and signed on parent CA

name

string

Required field. The name of the Certificate Authority.

description

string

An optional description of the Certificate Authority.

subjectSpec

Subject

Required field. The subject (e.g., common name, organization, etc.) for the CA.

algorithm

enum (Algorithm)

Required field. The algorithm for the asymmetric key generation (e.g., RSA, ECC).

• ALGORITHM_UNSPECIFIED
• RSA_2048_PSS_SHA_256
• RSA_2048_PSS_SHA_384
• RSA_2048_PSS_SHA_512
• RSA_3072_PSS_SHA_256
• RSA_3072_PSS_SHA_384
• RSA_3072_PSS_SHA_512
• RSA_4096_PSS_SHA_256
• RSA_4096_PSS_SHA_384
• RSA_4096_PSS_SHA_512
• ECDSA_NIST_P256_SHA_256
• ECDSA_NIST_P384_SHA_384
• ECDSA_NIST_P521_SHA_512
• ECDSA_SECP256_K1_SHA_256
• RSA_2048_PKCS1_5_SHA_256: RSA PKCS 1.5
• RSA_2048_PKCS1_5_SHA_384
• RSA_2048_PKCS1_5_SHA_512
• RSA_3072_PKCS1_5_SHA_256
• RSA_3072_PKCS1_5_SHA_384
• RSA_3072_PKCS1_5_SHA_512
• RSA_4096_PKCS1_5_SHA_256
• RSA_4096_PKCS1_5_SHA_384
• RSA_4096_PKCS1_5_SHA_512

pathLen

string (int64)

The maximum length of the certificate chain.

keyUsage[]

enum (KeyUsageExtension)

Key usage (e.g., keyEncipherment, digitalSignature).

• KEY_USAGE_EXTENSION_UNSPECIFIED
• DIGITAL_SIGNATURE
• CONTENT_COMMITMENT
• KEY_ENCIPHERMENT
• DATA_ENCIPHERMENT
• KEY_AGREEMENT
• KEY_CERT_SIGN
• CRL_SIGN
• ENCIPHER_ONLY
• DECIPHER_ONLY

extendedKeyUsage[]

enum (ExtendedKeyUsageExtension)

Extended key usage (e.g., serverAuth, clientAuth).

• EXTENDED_KEY_USAGE_EXTENSION_UNSPECIFIED
• SERVER_AUTH
• CLIENT_AUTH
• CODE_SIGNING
• EMAIL_PROTECTION
• TIME_STAMPING
• OCSP_SIGNING
• IPSEC_IKE
• MS_CODE_IND
• MS_CODE_COM
• MS_CTL_SIGN
• MS_EFS

ttlDays

string (int64)

The Time-To-Live (TTL) in days for the CA.

endEntitiesTtlLimitDays

string (int64)

TTL limit in days for end-entities signed by the CA.

templateId

string

Optional template ID to fill certificate fields with template data. Explicitly defined parameters is preferred

enableCrl

boolean

Enable Certificate Revocation List (CRL) support.

enableOcsp

boolean

Enable Online Certificate Status Protocol (OCSP) support.

deletionProtection

boolean

Protect the CA from accidental deletion. Deny deletion of ca if set

Field

Description

baseRdn

BaseRDN

Required field. Most used field of subject

additionalRdn

AdditionalRDN

Additional fields of subject

Field

Description

country

string

Two letter county code

organization

string

Organization name in arbitrary form

organizationalUnit

string

Organizational unit name in arbitrary form

distinguishedNameQualifier

string

Distinguished name qualifier

stateOrProvince

string

State or province name in arbitrary form

commonName

string

Common name. For tls certificates it is domain usually.

emailAddress

string

Email address of certificate owner

Field

Description

serialNumber

string

Serial number of certificate subject in arbitrary form. Don't confuse with certificate serial number.

locality

string

Locality of certificate subject in arbitrary form.

title

string

Title of certificate subject in arbitrary form.

surname

string

Surname of certificate subject in arbitrary form.

givenName

string

Given name of certificate subject in arbitrary form.

initials

string

Initials of certificate subject in arbitrary form.

generationQualifier

string

Generation qualifier of certificate subject in arbitrary form.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

GenerateCertificateAuthorityMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

CertificateAuthority

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

certificateAuthorityId

string

ID of the Certificate Authority being created.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the certificate authority.

folderId

string

ID of the folder that the certificate authority belongs to.

name

string

Name of the certificate authority.

description

string

Description of the certificate authority.

parentCertificateAuthorityId

string

ID of the parent certificate authority that signed this certificate authority if any.

status

enum (Status)

Status of the certificate authority.

• STATUS_UNSPECIFIED
• UNSIGNED: The certificate authority is unsigned and pending signing.
• ACTIVE: The certificate authority is active and can issue certificates.

issuedAt

string (date-time)

Time when the certificate authority was issued.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

notAfter

string (date-time)

Time after which the certificate authority is not valid.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

notBefore

string (date-time)

Time before which the certificate authority is not valid.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

crlEndpoint

string

Endpoint of the certificate revocation list (CRL) for the certificate authority.

endEntitiesTtlLimitDays

string (int64)

Maximum allowed TTL (in days) for end-entity certificates issued by this CA.

deletionProtection

boolean

Flag that protects deletion of the certificate authority.

createdAt

string (date-time)

Time when the certificate authority was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time when the certificate authority was last updated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).