Update PKI Role
const url = 'https://example.com/vault/v1/workspaces/example/engines/qibdo/certificateAuthorities/example/roles/example';const options = {method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/vault/v1/workspaces/example/engines/qibdo/certificateAuthorities/example/roles/example \ --header 'Content-Type: application/json' \ --data '{}'Updates a PKI role’s allowed_domains, max_ttl, allowed_key_types and/or allowed_extended_key_usages. Re-projects the role to the engine.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the role belongs to.
The CA the role is attached to.
The unique identifier of the role to update.
Query Parameters
Section titled “Query Parameters ”Fields to update. Omit for implied mask (all populated fields).
Use * for full replacement of the mutable fields.
Request Body required
Section titled “Request Body required ”QibdoPkiRole resource: a per-CA, workspace-scoped role that constrains
which certificates a caller may request from IssueQibdoCertificate. A
role is the certificate-issuance contract: every issuance is checked
against four dimensions before the engine is touched:
- allowed_domains: requested common_name + SANs must match
- max_ttl: requested ttl must not exceed
- allowed_key_types: requested key algorithm must be in the set
- allowed_extended_key_usages: requested EKUs must be in the set
Roles are projected to the vault via POST /v1/
object
The unique identifier of the PKI role (UUID).
The workspace this role belongs to (UUID, weak reference to taxonomy.workspaces).
The certificate authority this role is attached to (UUID).
(CA-unique) human-readable role name. Mirrored as the role name on the vault side. 3–64 chars, lowercase letters/digits/hyphen, neither leading nor trailing hyphen.
Allowed Common Name / SAN domain patterns. Accepts bare DNS labels and
a single leading-wildcard form (*.example.com). At most 64 entries,
each at most 253 chars.
Maximum total lifetime any certificate issued under this role may hold.
Allowed crypto algorithms / key sizes. Names must match the
CryptoAlgorithm enum (e.g., RSA_2048, EC_P256, ED25519).
At most 16 entries.
Allowed Extended Key Usages.
Timestamp when the row was created (server-managed).
Timestamp when the row was last modified (server-managed).
Weak reference to a topology Location: where this resource resides. Defaults to the global location when omitted at creation and is immutable thereafter. Only the global location is available in this release.
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.
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" } ]}