Skip to main content
GET
Get an OAuth client

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant. Send client_id:client_secret as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for one hour (configurable). Decode them at jwt.io.

Path Parameters

id
string
required

Response

ok

object
enum<string>
required
Available options:
oauth_client
id
string
required

The client_id, prefixed client_.

Example:

"client_3Jx9XfQwVZBfwUyZQ8H6"

name
string
required
Example:

"ci-keys"

scopes
string[]
required
mode
enum<string>
required
Available options:
live,
test
active
boolean
required
created_at
string<date-time>
required
ledger_id
string<uuid> | null
last_used_at
string<date-time> | null
client_secret
string

Plaintext secret. Returned only on create + rotate.

client_secret_note
string

Hint to the integrator that the secret is shown once.

previous_secret_expires_at
string<date-time>

Returned on rotate. UTC timestamp 24h in the future, until which the previous secret continues to authenticate at POST /oauth/token.