v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132571117.1 KB
projects

Create a new Certificate in a given Project, Location from a particular CaPool.

post/v1/{+parent}/certificates

Path parameters

parentstring required

Required. The resource name of the CaPool associated with the Certificate, in the format projects/*/locations/*/caPools/*.

Query parameters

certificateIdstring

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 in the Enterprise CertificateAuthority.tier, but is optional and its value is ignored otherwise.

issuingCertificateAuthorityIdstring

Optional. The resource ID of the 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 referenced by parent. Per-CA quota rules apply. If left empty, a CertificateAuthority will be chosen from the CaPool by the service. For example, to issue a 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 to "projects/my-project/locations/us-central1/caPools/my-pool" and the issuing_certificate_authority_id to "my-ca".

requestIdstring

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).

validateOnlyboolean

Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.

Request body

certificateTemplatestring

Immutable. The resource name for a 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.

createTimestring google-datetime

Output only. The time at which this Certificate was created.

labelsobject

Optional. Labels with user-defined metadata.

pemCsrstring

Immutable. A pem-encoded X.509 certificate signing request (CSR).

issuerCertificateAuthoritystring

Output only. The resource name of the issuing CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

lifetimestring google-duration

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.

subjectMode'SUBJECT_REQUEST_MODE_UNSPECIFIED' | 'DEFAULT' | 'RDN_SEQUENCE' | 'REFLECTED_SPIFFE'

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used.

updateTimestring google-datetime

Output only. The time at which this Certificate was updated.

requestedNotBeforeTimestring google-datetime

Optional. The requested not_before_time of this Certificate. This field may only be set if the CaPool.IssuancePolicy.allow_requester_specified_not_before_time field is set to true for the issuing CaPool. If this field is specified, the certificate will be issued with this 'not_before_time'. If this is not specified, the 'not_before_time' will be set to the issuance time or issuance time minus backdate_duration depending on the CaPool configuration.

pemCertificateChainstring[]

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.

namestring

Identifier. The resource name for this Certificate in the format projects/*/locations/*/caPools/*/certificates/*.

pemCertificatestring

Output only. The pem-encoded, signed X.509 certificate.

Response

Successful response