API Explorer 935 endpoints

Get OIDC Client

GET /obp/v7.0.0/oidc/clients/CLIENT_ID

OBPv6.0.0-getOidcClient Roles: CanGetOidcClient OIDCConsumerOAuth

Gets an OIDC/OAuth2 client's metadata by client_id.

Returns client information including name, consumer_id, redirect_uris, and enabled status. This endpoint does not verify the client secret - use POST /oidc/clients/verify for authentication.

redirect_uris lists only the Consumer's redirect URLs that meet the redirect URL rules (https; http only for localhost, 127.0.0.1 or [::1]; or an app scheme in reverse-domain form; no wildcard, user information or fragment). A stored entry that fails them is left out, so an OIDC provider never redirects to it. See here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.

URL Parameters:

CLIENT_ID: CLIENT_ID

JSON response body fields (5)
client_id
client_id
client_name
client_name
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
enabled
false
redirect_uris
redirect_uris
Example success response
{
  "client_id": "abc123def456",
  "client_name": "My Application",
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "redirect_uris": [
    "https://app.example.com/callback"
  ],
  "enabled": true
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
  • OBP-20200: The application cannot be identified.
Implemented by OBPv6.0.0 getOidcClient Originally /obp/v6.0.0/oidc/clients/CLIENT_ID