Get one OAuth client through the Agent-safe projection.

GET

/api/admin/agent-read/clients/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/agent-read/clients/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• adminBearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 128 characters

Responses

200

Safe client configuration.

Media type application/json

object

client

required

object

client_id

required

string

client_name

string | null

description

string | null

application_type

string | null

redirect_uris

Array<string> | null

grant_types

Array<string> | null

response_types

Array<string> | null

token_endpoint_auth_method

string | null

scope

string | null

allowed_scopes

Array<string> | null

allowed_channels

Array<string> | null

require_pkce

boolean | null

is_trusted

boolean | null

skip_consent

boolean | null

initiate_login_uri

string | null

allowed_redirect_origins

Array<string> | null

web_origin_registry

object | null

created_at

integer | null format: int64

updated_at

integer | null format: int64

key

additional properties

resource_version

required

string

>= 43 characters <= 43 characters

Example ^generated

{
  "client": {
    "client_id": "example",
    "client_name": "example",
    "description": "example",
    "application_type": "example",
    "redirect_uris": [
      "example"
    ],
    "grant_types": [
      "example"
    ],
    "response_types": [
      "example"
    ],
    "token_endpoint_auth_method": "example",
    "scope": "example",
    "allowed_scopes": [
      "example"
    ],
    "allowed_channels": [
      "example"
    ],
    "require_pkce": true,
    "is_trusted": true,
    "skip_consent": true,
    "initiate_login_uri": "example",
    "allowed_redirect_origins": [
      "example"
    ],
    "web_origin_registry": "example",
    "created_at": 1,
    "updated_at": 1
  },
  "resource_version": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}