Get Current Consumer Identity
GET /obp/v7.0.0/consumers/current/identity
OBPv7.0.0-getCurrentConsumerIdentity No role required ConsumerAPI
Returns the identity of the Consumer making this call: consumer_id and consumer_name.
Nothing else is returned: no description, no key, no rate limits, no call counters. For those, see Get Current Consumer (v6.0.0), which requires a Role.
No Role is required. The caller must be identifiable as a Consumer, either through a logged-in User (whose Consumer this is) or as an Application on its own (OAuth2 client credentials, or a Consumer Key). A call with no credentials gets OBP-20200: The application cannot be identified.
Use it from a service (for example the Portal or the API Manager) to show which Consumer it is configured with, or to check that its client id matches a registered Consumer.
User Authentication is Optional. The User need not be logged in.
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 response body fields (2)
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- consumer_name
- consumer_name
Example success response
{
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"consumer_name": "OBP Portal"
}Possible errors (2)
- OBP-20200: The application cannot be identified.
- OBP-50000: Unknown Error.