API Explorer 1 endpoints

Get all Scopes

GET /obp/v7.0.0/scopes

OBPv7.0.0-getAllScopes Roles: CanGetAllScopes ScopeRole

Get every Scope on this instance, for all Consumers: its bank_id, role_name and consumer_id.

A Scope is a Role granted to a Consumer (an application) rather than to a User; see here. For the Scopes of one Consumer, see Get Scopes for Consumer.

Who may call it. A User with the Role CanGetAllScopes, or an application whose Consumer holds it as a Scope.

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 response body fields (4)
bank_id
gh.29.uk
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
role_name
scopes
Example success response
{
  "scopes": [
    {
      "bank_id": "",
      "role_name": "CanGetTelemetry",
      "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    }
  ]
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
  • OBP-20200: The application cannot be identified.
Implemented by OBPv7.0.0 getAllScopes