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

Issue Certificate

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/certificateAuthorities/{certificate_authority}/certificates
curl --request POST \
--url https://example.com/vault/v1/workspaces/example/engines/qibdo/certificateAuthorities/example/certificates \
--header 'Content-Type: application/json' \
--data '{ "workspace": "example", "certificate_authority": "example", "role": "example", "common_name": "example", "subject_alternative_names": [ "example" ], "ttl": "example", "tags": [ { "key": "example", "value": "example", "type": "VAULT_TAG_TYPE_UNSPECIFIED", "description": "example" } ], "requested_key_type": "example", "requested_extended_key_usages": [ "EXTENDED_KEY_USAGE_UNSPECIFIED" ] }'

Issues a new leaf certificate under the given CA / role. The CA must be active (not revoked). Returns a long-running operation whose payload references the resulting QibdoCertificate.

workspace
required
string

The workspace the CA belongs to.

certificate_authority
required
string

The CA that will issue the certificate.

Media type application/json

Request payload for Issue Qibdo Certificate

Carries the input fields required to issue qibdo certificate.

object
workspace
required

The workspace the CA belongs to.

string
certificate_authority
required

The CA that will issue the certificate.

string
role
required

The QibdoPkiRole used to constrain certificate parameters (allowed domains, key types, max TTL, allowed extended key usages). Carried as a UUID identifying the role aggregate; the handler loads the role and enforces all four dimensions before delegating to the engine.

string
common_name
required

Common Name for the issued certificate (typically a DNS name or service identity). Subject DN is composed from this.

string
subject_alternative_names

Optional Subject Alternative Names — DNS names, IP addresses, or URIs.

Array<string>
ttl
required

Requested validity duration. The role’s max_ttl caps the granted TTL — the vault backend silently truncates if exceeded.

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

Optional tag entries used for organisation and policy matching.

Array<object>

Vault Tag

A key-value pair used to label and categorize vault resources such as secrets, crypto keys, leases, certificate authorities, certificates, and access policies.

object
key
required

Tag Key

Tag key (1–63 chars, lowercase letters/digits/dashes/underscores).

string
value
required

Tag Value

Tag value (free-form, up to 255 chars).

string
type

Tag Type

Whether the tag is system-managed or user-defined.

string format: enum
Allowed values: VAULT_TAG_TYPE_UNSPECIFIED VAULT_TAG_TYPE_SYSTEM VAULT_TAG_TYPE_USER
description

Tag Description

Optional description.

string
requested_key_type

Optional requested key algorithm. When omitted the role’s first allowed key type is implied. Names must match the CryptoAlgorithm enum (RSA_2048, EC_P256, ED25519, etc.). When provided, must appear in the role’s allowed_key_types; otherwise INVALID_ARGUMENT.

string
requested_extended_key_usages

Optional requested Extended Key Usages. When non-empty, every entry must appear in the role’s allowed_extended_key_usages; otherwise INVALID_ARGUMENT.

Array<string>
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

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 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"
}
]
}