Skip to content
Kapten
Esc
↑↓navigate↵open⌘Jpreview

Get an OAuth application

Requires being a member.

GET/organizations/{organizationId}/oauth-clients/{clientId}
Authorization
AuthorizationBearer token (JWT) · headerrequired

An access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.

Path parameters
organizationIdstring<uuid>required
clientIdstring<uuid>required

The client's id, the uuid in its cli_<id> client_id.

Responses
200

The client.

idstring<uuid>required
client_idstringrequired

The OAuth client_id, cli_<id>; the username of client_secret_basic, the iss and sub of its client assertions and the sub of its access tokens.

namestringrequired
scopesstring[]required

Scopes the client may request. A token request without scope gets all of them.

rolesstring[]required

Names of the organization's Roles the client holds, which decide what its tokens may do.

keysoauth_client_key[]required

Registered public keys, revoked ones included, oldest first.

Show properties
Array of oauth_client_key
idstring<uuid>required
kidstringrequired

The key's RFC 7638 SHA-256 thumbprint. Client assertions may name the key by it, or by the jwk's own kid, in their kid header.

jwkpublic_jwkrequired

A public signing key (RFC 7517) - EC P-256, P-384 or P-521, Ed25519 (OKP), or RSA of 2048 bits or more. Private members are refused; use, when present, must be sig.

created_atstring<date-time>required
revoked_atstring<date-time>

Set once the key is revoked; assertions it signs are refused.

secretsoauth_client_secret[]required

Client secrets, revoked and expired ones included, oldest first. Only the response that created a secret holds its value.

Show properties
Array of oauth_client_secret
idstring<uuid>required
secretstring

The secret, kapten_sk_ followed by 43 base64url characters. Present only in the response that created it; it cannot be read again.

hintstringrequired

The secret's last four characters, to tell secrets apart.

created_atstring<date-time>required
expires_atstring<date-time>

When the secret stops authenticating the client; absent when it does not expire.

revoked_atstring<date-time>

Set once the secret is revoked; it then authenticates nothing.

created_atstring<date-time>required
updated_atstring<date-time>required
revoked_atstring<date-time>

Set once the client is revoked; it then gets no token and holds no Role.

default

The request failed.

errorstringrequired

Stable machine-readable code.

Allowed:invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternal
messagestringrequired

Human-readable explanation.

Request
curl -X GET 'https://auth.kapten.io/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/oauth-clients/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "client_id": "string",
  "name": "string",
  "scopes": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "keys": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kid": "string",
      "jwk": {},
      "created_at": "2019-08-24T14:15:22Z",
      "revoked_at": "2019-08-24T14:15:22Z"
    }
  ],
  "secrets": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "secret": "string",
      "hint": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "revoked_at": "2019-08-24T14:15:22Z"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "revoked_at": "2019-08-24T14:15:22Z"
}

Was this page helpful?