entity-group > user

Sync Group Users

Sync entity group users. This will add users to entities that do not have them and remove users from entities that have them.

post/entityGroup/{entityGroupId}/sync-users

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entityGroup/{entityGroupId}/sync-users
  • Auth: HTTP bearer

Path parameters

entityGroupIdstring required

Entity Group ID or Entity Group ForeignID

Request body

copyUsersFromstring
filterRolesstring[]

List of roles to filter users by. If not provided, all users will be copied. If provided, only users with the provided roles will be copied.

addUsersboolean

If true, users will be added to entities if they are not found in the copyUsersFrom entity. Default is true.

removeUsersboolean

If true, users will be removed from entities if they are not found in the copyUsersFrom entity. Default is false.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.