Get Database Role

GET

/vault/v1/workspaces/{workspace}/engines/qibdo/databaseroles/{id}

curl --request GET \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/databaseroles/example

Returns a database role’s metadata by ID.

Parameters

Path Parameters

workspace

required

string

The workspace the role belongs to.

id

required

string

The unique identifier of the role to retrieve.

Responses

200

OK

Media type application/json

QibdoDatabaseRole resource — a workspace-scoped, Qibdo-managed database role definition. Carries the creation + revocation SQL templates that the vault will execute when issuing or revoking dynamic database credentials. Qibdo is the single source of truth; the vault receives a derived projection via POST /v1/database/roles/{name} after the templates have been dry-run validated against the target database.

object

id

The unique identifier of the database role (UUID).

stringOutput only

workspace_id

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

stringOutput only

name

Workspace-unique human-readable role name. Mirrored as the role name on the vault side.

stringOutput only

db_engine

Target database engine.

string format: enum Output only

Allowed values: DB_ENGINE_UNSPECIFIED DB_ENGINE_POSTGRES DB_ENGINE_MYSQL DB_ENGINE_MSSQL DB_ENGINE_MONGODB DB_ENGINE_ORACLE DB_ENGINE_REDSHIFT DB_ENGINE_CASSANDRA

connection_ref

Reference to the target database connection (engine-specific opaque string — e.g., the vault’s database connection name or a JDBC URL key in the JdbcConnectionRegistry).

stringOutput only

creation_statements

SQL statements executed at credential issuance. Engine-specific placeholders ({{name}}, {{password}}, {{expiration}}) are honoured. Capped to bound storage in vault.database_roles and prevent abuse: at most 64 statements, each at most 8 KiB.

Array<string>Output only

revocation_statements

SQL statements executed at credential revocation ({{name}} placeholder). Same caps as creation_statements.

Array<string>Output only

default_ttl

Default time-to-live applied to credentials issued under this role.

stringOutput only

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

max_ttl

Maximum total lifetime any credential under this role can hold.

stringOutput only

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

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

Example

{
  "db_engine": "DB_ENGINE_UNSPECIFIED"
}

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