Skip to content

Retrieve OAuth2 client

Request

Read the current registration of an OAuth2 client (RFC 7592 Section 2.1). Authenticate with the registration_access_token returned at registration, as a Bearer token in the Authorization header. An invalid or missing token returns 401 without revealing whether the client exists.

Security
RegistrationAccessToken
Path
clientIdstringrequired

The client identifier issued at registration.

Examples:
Client ID
client_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d
curl -i -X GET \
  https://cafe.redocly.com/_mock/openapi/cafe/oauth2/register/client_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current client registration.

Bodyapplication/json
client_idstringrequired

Client identifier issued by the authorization server.

client_secretstringrequired

Client secret issued by the authorization server. Store it securely.

client_id_issued_atinteger, (int64)required

Time when the client_id is issued, represented as seconds since epoch (RFC 7591).

client_secret_expires_atinteger, (int64)required

Time at which the client_secret expires, represented as seconds since epoch. 0 indicates the secret does not expire (RFC 7591).

registration_client_uristring, (uri)required

URL of the client configuration endpoint for managing this client registration (RFC 7592).

registration_access_tokenstringrequired

Bearer token for the client configuration endpoint (RFC 7592). Store it securely.

client_namestring

Client name (registered metadata). Omitted for clients registered without a name.

redirect_urisArray of strings, (uri)required

Registered redirect URIs.

grant_typesArray of stringsrequired

Registered grant types.

Items Enum:"authorization_code""client_credentials""refresh_token"
scopestringrequired

Space-separated registered scopes.

token_endpoint_auth_methodstringrequired

Registered token endpoint authentication method. Defaults to client_secret_basic when not requested at registration (RFC 7591 Section 2). The token and revocation endpoints accept both methods for every client regardless.

Enum:"client_secret_basic""client_secret_post"
Response
{ "client_id": "string", "client_secret": "string", "client_id_issued_at": 0, "client_secret_expires_at": 0, "registration_client_uri": "http://example.com", "registration_access_token": "string", "client_name": "string", "redirect_uris": [ "http://example.com" ], "grant_types": [ "authorization_code" ], "scope": "string", "token_endpoint_auth_method": "client_secret_basic" }