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

Issue SSH OTP

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/ssh/{source_role}/otp
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/ssh/example/otp \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "source_role": "example", "username": "example", "ip_address": "example" }'

Issues a one-time SSH password for a username + target IP pair. Requires the target host to run the the vault backend SSH OTP helper. Bound to a QibdoLease.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace to issue the OTP under.

source_role
required
string

The pre-configured OTP role.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request payload for Issue Ssh Qibdo Otp

Carries the input fields required to issue ssh qibdo otp.

object
workspace
required

The workspace to issue the OTP under.

string
source_role
required

The pre-configured OTP role.

string
username
required

The username that will use the OTP on the target host.

string
ip_address
required

The target host IP address.

string
Example generated
{
  "workspace": "example",
  "source_role": "example",
  "username": "example",
  "ip_address": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from Issue Ssh Qibdo Otp

Carries the output produced by issue ssh qibdo otp.

object
credential

The freshly issued one-time password bundled with its lease handle. The credential’s username/password fields carry the SSH username + OTP.

object
lease

The lease metadata for this credential — the persistent server-side handle used to renew or revoke the credential.

object
id

The unique identifier of the lease (UUID).

stringOutput only
workspace_id

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

stringOutput only
principal_id

The principal (IAM user / service account) the lease was issued to.

stringOutput only
ttl

Initial time-to-live for the lease.

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

Maximum total lifetime including renewals — capped by the engine.

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

Whether the lease can be renewed.

booleanOutput only
revocable

Whether the lease can be revoked early.

booleanOutput only
issued_at

Timestamp when the lease was issued.

string format: date-time Output only
expires_at

Timestamp when the lease expires (may be extended by RenewQibdoLease).

string format: date-time Output only
status

Current lifecycle status of the lease.

string format: enum Output only
Allowed values: LEASE_STATUS_UNSPECIFIED LEASE_STATUS_ACTIVE LEASE_STATUS_RENEWED LEASE_STATUS_REVOKED LEASE_STATUS_EXPIRED
source_type

The engine that produced this lease (database / cloud_aws / cloud_gcp / cloud_azure / ssh / kubernetes).

string format: enum Output only
Allowed values: LEASE_SOURCE_TYPE_UNSPECIFIED LEASE_SOURCE_TYPE_DATABASE LEASE_SOURCE_TYPE_CLOUD_AWS LEASE_SOURCE_TYPE_CLOUD_GCP LEASE_SOURCE_TYPE_CLOUD_AZURE LEASE_SOURCE_TYPE_SSH LEASE_SOURCE_TYPE_KUBERNETES
source_role

Engine-specific role identifier the lease was issued against (e.g., the vault database role name for database leases).

stringOutput only
engine_lease_id

The engine-side lease identifier (e.g., vault lease ID). Used as the prefix key for bulk-revoke operations.

stringOutput only
created

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

string format: date-time Output only
updated

Timestamp when the lease metadata 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
username

The username portion of the credential (e.g., a transient database role).

stringOutput only
password

The password portion of the credential. Returned exactly once — clients MUST store it before the lease expires.

stringOutput only
Example 
{
  "credential": {
    "lease": {
      "status": "LEASE_STATUS_UNSPECIFIED",
      "source_type": "LEASE_SOURCE_TYPE_UNSPECIFIED"
    }
  }
}

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