Get Reachable Roles
GET /obp/v7.0.0/reachable-roles
OBPv7.0.0-getReachableRoles Roles: CanGetReachableRoles RoleEntitlement
Get the names of the Roles that someone holds on this instance, as an Entitlement (a User) or as a Scope (a Consumer), each listed once.
An endpoint that needs a Role can only be reached if someone holds that Role, so together with the Resource Docs this tells which endpoints can be reached here. Nothing else is returned: no Users, no Consumers, no bank ids.
Who may call it. A User with the Role CanGetReachableRoles, or an application whose Consumer holds it as a Scope, such as a code-review service run as a Platform App (see here).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
This endpoint supports User XOR Application authorisation: either a person acting on their own Entitlements, or an Application acting as itself (e.g. with an OAuth2 client-credentials token) on its Consumer's Scopes. A person calling through a Consumer does not get that Consumer's Scopes. See here for more information.
JSON response body fields (1)
- role_names
- role_names
Example success response
{
"role_names": [
"CanGetCustomersAtOneBank",
"CanGetTelemetry"
]
}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.