Get Current Consumer Scopes
GET /obp/v7.0.0/consumers/current/scopes
OBPv7.0.0-getCurrentConsumerScopes No role required ConsumerScopeAPI
Returns the Roles the Consumer making this call holds as Scopes, each with its bank_id
(a bank id, SYS for the system space, or empty for a system 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 check that its Consumer holds the Scopes it needs. To list another Consumer's Scopes, see Get Scopes for 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 (4)
- bank_id
- gh.29.uk
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- role_name
- scopes
Example success response
{
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"scopes": [
{
"role_name": "CanGetDynamicEntityDefinitions",
"bank_id": "SYS"
}
]
}Possible errors (2)
- OBP-20200: The application cannot be identified.
- OBP-50000: Unknown Error.