Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Update PKI Role

PATCH
/vault/v1/workspaces/{workspace}/engines/qibdo/certificateAuthorities/{certificate_authority}/roles/{id}
 
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 ”
workspace
required
string

The workspace the role belongs to.

certificate_authority
required
string

The CA the role is attached to.

id
required
string

The unique identifier of the role to update.

Query Parameters

Section titled “Query Parameters ”
update_mask
string format: field-mask

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 ”
Media type application/json

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//roles/{name} during register/update. Delete unbinds the engine-side role.

object
id

The unique identifier of the PKI role (UUID).

stringOutput only
workspace_id

The workspace this role belongs to (UUID, weak reference to taxonomy.workspaces).

stringOutput only
certificate_authority_id

The certificate authority this role is attached to (UUID).

stringOutput only
name

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

stringOutput only
allowed_domains

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.

Array<string>Output only
max_ttl

Maximum total lifetime any certificate issued under this role may hold.

stringOutput only
/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/
allowed_key_types

Allowed crypto algorithms / key sizes. Names must match the CryptoAlgorithm enum (e.g., RSA_2048, EC_P256, ED25519). At most 16 entries.

Array<string>Output only
allowed_extended_key_usages

Allowed Extended Key Usages.

Array<string>Output only
Allowed values: EXTENDED_KEY_USAGE_UNSPECIFIED EXTENDED_KEY_USAGE_SERVER_AUTH EXTENDED_KEY_USAGE_CLIENT_AUTH EXTENDED_KEY_USAGE_CODE_SIGNING EXTENDED_KEY_USAGE_EMAIL_PROTECTION EXTENDED_KEY_USAGE_TIME_STAMPING EXTENDED_KEY_USAGE_OCSP_SIGNING EXTENDED_KEY_USAGE_IPSEC_USER EXTENDED_KEY_USAGE_IPSEC_TUNNEL
created

Timestamp when the row was created (server-managed).

string format: date-time Output only
updated

Timestamp when the row was last modified (server-managed).

string format: date-time Output only
location_id

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.

stringOutput only

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Vault Operation

Tracks the result of a vault command (secret, crypto key, lease, certificate authority, certificate, access policy, or vault-level lifecycle action).

object
id

Operation ID

Unique identifier of the operation.

stringOutput only
workspace_id

Workspace ID

The workspace in whose namespace the operation was executed.

stringOutput only
resource_id

Resource ID

ID of the affected resource (nullable for vault-level lifecycle ops such as snapshot).

stringOutput only
resource_type

Resource Type

URN of the affected resource type (e.g., “com.qibdo.cloud.vault:secret”).

stringOutput only
operation_type

Operation Type

The action performed (CREATE, ROTATE, REVOKE, ENCRYPT, …).

stringOutput only
status

Status

The operation status (PENDING, RUNNING, DONE, FAILED).

stringOutput only
insert_time

Insert Time

When the operation was created.

string format: date-time Output only
start_time

Start Time

When execution started (nullable).

string format: date-time Output only
end_time

End Time

When execution completed (nullable).

string format: date-time Output only
progress

Progress

Progress percentage (0–100).

integer format: int32 Output only
warnings

Warnings

Non-fatal notices emitted during the operation.

Array<object>Output only

Vault Warning

A non-fatal notice emitted by a vault operation. The operation still completed; the warning surfaces unsupported features or capability gaps in the underlying engine.

Warning codes follow the S_SSS_EEE convention:

  • Millions digit: service (9 = vault)
  • Thousands: group
  • Units: specific warning
object
code

Warning Code

Numeric identifier of the warning type.

integer format: uint32 Output only
description

Description

Human-readable explanation of what was ignored or degraded.

stringOutput only
Example generated
{}

default

Section titled “default ”

Default error response

Media type application/json

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
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

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.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}