Grant User Membership to Group Entitlements
POST /obp/v7.0.0/users/USER_ID/group-entitlements
OBPv6.0.0-addUserToGroup No role required GroupUserEntitlement
Grant the User Group Entitlements.
This endpoint creates entitlements for every Role in the Group. If the user already has a particular role at the same bank, that entitlement is skipped (not duplicated).
The membership itself is recorded too, so the user is a member of the Group even when every Role was skipped.
Each entitlement created will have:
- group_id set to the group ID
- process set to "GROUP_MEMBERSHIP"
Response Fields (7)
- - target_entitlements
- All roles defined in the group (the complete list of entitlements that this group aims to grant)
- - entitlements_created
- Roles that were newly created as entitlements during this operation
- - entitlements_skipped
- Roles that the user already possessed, so no new entitlement was created
- Note
- target_entitlements = entitlements_created + entitlements_skipped
- Requires either
- URL Parameters
- **
- USER_ID
- 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
- CanAddUserToGroupAtAllBanks (for any group)
- CanAddUserToGroupAtOneBank (for groups at specific bank) User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields (1)
- group_id
- group_id
JSON response body fields (7)
Example request body
{
"group_id": "group-id-123"
}Example success response
{
"group_id": "group-id-123",
"user_id": "user-id-123",
"bank_id": "gh.29.uk",
"group_name": "Teller Group",
"target_entitlements": [
"CanGetCustomer",
"CanGetAccount",
"CanCreateTransaction"
],
"entitlements_created": [
"CanGetCustomer",
"CanGetAccount"
],
"entitlements_skipped": [
"CanCreateTransaction"
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.