API Explorer 891 endpoints

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, redirect_uris and grant_types for use by the OIDC provider.

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.

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 (4)
  • 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.
Implemented by OBPv6.0.0 verifyOidcClient Originally /obp/v6.0.0/oidc/clients/verify