Verify OIDC Client
POST /obp/v7.0.0/oidc/clients/verify
OBPv6.0.0-verifyOidcClient Roles: CanVerifyOidcClient OIDCConsumerOAuth
Verifies an OIDC/OAuth2 client's credentials.
Returns valid: true if the client_id and client_secret match an active consumer.
Also returns the consumer_id and redirect_uris for use by the OIDC provider.
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.
JSON request body fields (2)
- client_id
- client_id
- client_secret
- client_secret
JSON response body fields (4)
- valid
- valid
- client_id
- client_id
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- redirect_uris
- redirect_uris
Example request body
{
"client_id": "abc123def456",
"client_secret": "supersecret123"
}Example success response
{
"valid": true,
"client_id": "abc123def456",
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"redirect_uris": [
"https://app.example.com/callback"
]
}Possible errors (5)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20200: The application cannot be identified.