API Explorer 891 endpoints

Get My Consumer Scopes

GET /obp/v7.0.0/my/consumers/CONSUMER_ID/scopes

OBPv7.0.0-getMyConsumerScopes No role required ConsumerScopeOrganisation

Get the Scopes one of your Consumers holds: the Roles it may use when it acts as itself, and where. A bank_id of "" means a system Role.

You may read a Consumer here if you created it and it belongs to no Organisation, or if it belongs to an active Organisation you are a member of. Any other CONSUMER_ID answers 404. The consumer key and secret are never returned.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

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": "CanGetCustomersAtOneBank",
      "bank_id": "gh.29.uk"
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30643: Consumer not found. Please specify the CONSUMER_ID of a Consumer you created or one that belongs to your Organisation.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getMyConsumerScopes