Sync Group Member
POST /obp/v7.0.0/management/groups/GROUP_ID/users/USER_ID/sync
OBPv7.0.0-syncGroupMember No role required GroupUserEntitlement
Bring the Entitlements of one member of a Group in line with the Group's current Roles.
The same as Sync Group Members (POST /management/groups/GROUP_ID/sync-members), for one member only:
- a Role of the Group the member does not hold at the Group's bank id is granted (the member gets an email for it), recorded against this Group;
- an Entitlement this Group granted, for a Role the Group no longer has, is deleted, unless another Group the member is in, at the same bank id, still grants that Role: then it is kept and recorded against that Group (no email; the member's Roles do not change).
Entitlements granted by hand, or by other Groups, are not touched. The user is not added to or removed from the Group.
The user must be a member of the Group (added to it, or holding an Entitlement it granted), or 404.
With dry_run=true nothing is changed and the response says what would be.
Requires CanAddUserToGroupAtOneBank or CanAddUserToGroupAtAllBanks, and CanRemoveUserFromGroupAtOneBank or CanRemoveUserFromGroupAtAllBanks (the AllBanks Roles for a system level Group).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
GROUP_ID: GROUP_ID
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON request body fields (0)
JSON response body fields (11)
Example success response
{
"group_id": "group-id-123",
"bank_id": "gh.29.uk",
"dry_run": false,
"members": [
{
"user_id": "user-id-123",
"username": "felixsmith",
"entitlements_created": [
"CanGetCustomer"
],
"entitlements_deleted": [
"CanCreateTransaction"
],
"entitlements_moved": [
{
"role_name": "CanGetAccount",
"to_group_id": "group-id-456"
}
]
}
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-50000: Unknown Error.