Issue Certificate
const url = 'https://example.com/vault/v1/workspaces/example/engines/example/certificateAuthorities/example/certificates';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"certificate_template":"example","common_name":"example","subject_alternative_names":["example"],"ttl":"example","tags":[{"key":"example","value":"example","description":"example"}],"requested_key_type":"CRYPTO_ALGORITHM_UNSPECIFIED","requested_extended_key_usages":["EXTENDED_KEY_USAGE_UNSPECIFIED"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/vault/v1/workspaces/example/engines/example/certificateAuthorities/example/certificates \ --header 'Content-Type: application/json' \ --data '{ "certificate_template": "example", "common_name": "example", "subject_alternative_names": [ "example" ], "ttl": "example", "tags": [ { "key": "example", "value": "example", "description": "example" } ], "requested_key_type": "CRYPTO_ALGORITHM_UNSPECIFIED", "requested_extended_key_usages": [ "EXTENDED_KEY_USAGE_UNSPECIFIED" ] }'Issues a new leaf certificate under the given CA / template. The CA must be active (not revoked). Returns a long-running operation whose payload references the resulting Certificate.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the CA belongs to.
Vault engine selector.
The CA that will issue the certificate.
Request Body required
Section titled “Request Body required ”Certificate Request
What is being asked for. What remains of the issue request once the path-bound fields are removed, and therefore what the HTTP body carries (PROTO-032).
Deliberately NOT Certificate: that message is the ISSUED certificate — serial, PEM, validity
bounds, all OUTPUT_ONLY. A request and the thing it produces share a subject and almost nothing
else, and conflating them would put thirteen server-set fields in a body no caller may fill.
object
The CertificateTemplate used to constrain certificate parameters (allowed domains, key types, max TTL, allowed extended key usages). Carried as a UUID identifying the template aggregate; the handler loads the template and enforces all four dimensions before delegating to the engine.
Common Name for the issued certificate (typically a DNS name or service identity). Subject DN is composed from this.
Optional Subject Alternative Names: DNS names, IP addresses, or URIs.
Requested validity duration. The template’s max_ttl caps the granted TTL; the vault backend silently truncates if exceeded.
Optional tag entries used for organisation and policy matching.
Vault Tag
A key-value pair used to label and categorize vault resources such as secrets, crypto keys, certificate authorities, certificates, and certificate templates.
object
Tag Key
Tag key (1–63 chars, lowercase letters/digits/dashes/underscores).
Tag Value
Tag value (free-form, up to 255 chars).
Tag Type
Whether the tag is system-managed or user-defined.
Tag Description
Optional description.
Optional requested key algorithm. When omitted the template’s first allowed key type is implied.
When provided, must appear in the template’s allowed_key_types; otherwise INVALID_ARGUMENT.
Optional requested Extended Key Usages. When non-empty, every entry must appear in the template’s
allowed_extended_key_usages; otherwise INVALID_ARGUMENT.
Responses
Section titled “ Responses ”OK
Vault Operation
An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).
object
Operation ID
Unique identifier for this operation.
Resource ID
The ID of the resource affected by this operation. May be empty for vault-level lifecycle operations such as snapshot.
Resource Type
The type of resource (e.g., “com.qibdo.cloud.vault:secret”).
Operation Type
The kind of mutation that was requested.
Status
Current lifecycle state of the operation.
Insert Time
When the operation was first created.
Start Time
When the operation started executing.
End Time
When the operation completed (either successfully or with errors).
Errors
Business rule errors encountered during the operation.
Operation Error
A structured error returned inside an operation when a business rule fails.
object
Error Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the error.
Reason
Machine-readable error identifier in UPPER_SNAKE form — the same dispatch
key google.rpc.ErrorInfo.reason carries on the synchronous error plane.
Warnings
Non-fatal notices about the operation.
Operation Warning
A non-fatal notice attached to an operation. The operation still completed; the warning surfaces unsupported features or capability gaps in the underlying engine.
object
Warning Code
Numeric identifier following the S_SSS_EEE convention.
Description
Human-readable explanation of the warning.
Progress
Percentage of completion (0-100).
Scope Type
The category of scope the operation ran in or was triggered from. VAULT_SCOPE_TYPE_UNSPECIFIED when the operation is not scoped.
Scope ID
The resource this operation was scoped to — for example, when scope_type is VAULT_SCOPE_TYPE_WORKSPACE this is the workspace id. Empty for VAULT_SCOPE_TYPE_PLATFORM, which has no scoped resource, and when unscoped.
Principal ID
Who performed or triggered the operation, whether a person or a machine account. Always populated: platform-driven work records the reserved system principal, so every audit record names an actor.
Trace ID
W3C trace id, for correlating this operation with the traces and log lines of the request that caused it. Empty when the operation ran with no trace context — a scheduled or event-driven action rather than a request.
Object Reference
Where the artifact this operation produced was stored, as a platform object key. Set only by
operations that produce one — a snapshot names the object holding its recovery point, and each
snapshot writes its own, so this reference and checksum stay a matched pair for the life of
the operation record. Empty for every operation that produces no artifact.
Checksum
SHA-512 hex digest of the artifact bytes, so an audit consumer can verify integrity without ever holding the artifact itself. Empty for operations with no artifact.
Example
{ "operation_type": "VAULT_OPERATION_TYPE_UNSPECIFIED", "status": "VAULT_OPERATION_STATUS_UNSPECIFIED", "scope_type": "VAULT_SCOPE_TYPE_UNSPECIFIED"}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}