Skip to main content
GET
Get a credential

Authorizations

Authorization
string
header
required

An access token from Barndoor's identity provider, sent as Authorization: Bearer <token>. Use a service-account token from the OAuth 2.0 client-credentials grant for scripts and CI, or a signed-in user's token. The caller needs the admin role in the organization. Gateway API keys (bd-...) are not accepted here.

Path Parameters

id
string<uuid>
required

Record ID (UUID)

Response

OK

A credential: an upstream secret that providers reference. The secret itself is never returned.

auth_type
string
required

How the gateway authenticates upstream, for example bearer_api_key, x_api_key, azure_api_key, aws_role, or google_adc.

base_url
string
required
created_at
string<date-time>
required
id
string<uuid>
required
model_provider
string
required
name
string
required
org_id
string<uuid>
required
secret_path
string
required

Internal reference to the stored secret. This is not the secret.

settings
any
required
stores_key_material
boolean
required

Whether this credential's auth type stores a secret.

updated_at
string<date-time>
required
created_by_email
string | null
created_by_name
string | null
created_by_user_id
string<uuid> | null
last_change_note
string | null

Note explaining the last change.

last_modified_at
string<date-time> | null

When the last attributed change was made.

last_modified_by_email
string | null
last_modified_by_name
string | null
last_modified_by_user_id
string<uuid> | null
key_last4
string | null

Last four characters of the stored key, when the credential holds one.