Get Entitlements for the current User
GET /obp/v7.0.0/my/entitlements
OBPv3.0.0-getEntitlementsForCurrentUser No role required RoleEntitlementUser
Get Entitlements for the current User.
Stored Entitlements have an entitlement_id. Entries with an empty entitlement_id and empty bank_id are virtual: Roles the User holds because their USER_ID is listed in the props entry super_admin_user_ids (CanCreateEntitlementAtOneBank, CanCreateEntitlementAtAnyBank, CanGetAnyUser) or oidc_operator_user_ids (CanGetAnyUser, CanVerifyUserCredentials, CanVerifyOidcClient, CanGetOidcClient, CanGetOidcConsent, CanGetConsumers, CanCreateConsumer). Virtual Entitlements satisfy direct calls but cannot be placed in a Consent; GET /users/current (v6.0.0 and later) also reports which props entry grants each of them in created_by_process.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (4)
- bank_id
- gh.29.uk
- entitlement_id
- list
- role_name
Example success response
{
"list": [
{
"entitlement_id": "6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name": "CanQueryOtherUser",
"bank_id": "gh.29.uk"
}
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.