API Explorer 1884 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, enabled status and grant_types.

grant_types lists the OAuth2 grant types the client can be issued tokens for. These are the grant types an administrator set on the Consumer (PUT /obp/v7.0.0/management/consumers/CONSUMER_ID/grant-types). If none are set, they are authorization_code, refresh_token and client_credentials. 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. A URL must use https, or http for localhost, 127.0.0.1 or [::1] only, or an app scheme in reverse-domain form. It must not contain a wildcard, user information or a fragment. A stored URL that breaks these rules 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.

URL Parameters:

CLIENT_ID: CLIENT_ID

JSON response body fields (6)
client_id
client_id
client_name
client_name
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
enabled
false
grant_types
grant_types
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,
  "grant_types": [
    "authorization_code",
    "refresh_token",
    "client_credentials"
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getOidcClient Originally /obp/v6.0.0/oidc/clients/CLIENT_ID