Register PKI Role
const url = 'https://example.com/vault/v1/workspaces/example/engines/qibdo/certificateAuthorities/example/roles:register';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"workspace":"example","certificate_authority":"example","pki_role":{},"location_id":"example"}'};
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/qibdo/certificateAuthorities/example/roles:register \ --header 'Content-Type: application/json' \ --data '{ "workspace": "example", "certificate_authority": "example", "pki_role": {}, "location_id": "example" }'Defines a new PKI role under a CA. The role’s constraints are validated by domain business rules (well-formed name, non-empty allowed_domains with valid DNS patterns, positive max_ttl, non-empty allowed_key_types, non-empty allowed_extended_key_usages). On success the role is persisted and projected to the vault backend.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the role belongs to.
The CA the role is attached to.
Request Body required
Section titled “Request Body required ”Request payload for Register Qibdo Pki Role
Carries the input fields required to register qibdo pki role.
object
The workspace the role belongs to.
The CA the role is attached to.
The role to register.
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.
Optional weak reference to a topology Location where the role resides. Defaults to the global location when omitted; immutable after creation. Only the global location is available in this release.
Responses
Section titled “ Responses ”OK
Response payload from Register Qibdo Pki Role
Carries the output produced by register qibdo pki role.
object
The persisted role metadata.
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.
Example
{ "pki_role": { "allowed_extended_key_usages": [ "EXTENDED_KEY_USAGE_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" } ]}