API ReferenceEntity GroupUser

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.

Path parameters

entityGroupIdstringRequired
Entity Group ID or Entity Group ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
copyUsersFromstringOptional

Entity ID / foreign ID of an entity currently in the group to copy users and roles from. If not provided, users will be synced from the entity with the most users that has been updated most recently.

filterRoleslist of stringsOptional
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.
addUsersbooleanOptional
If true, users will be added to entities if they are not found in the copyUsersFrom entity. Default is true.
removeUsersbooleanOptional
If true, users will be removed from entities if they are not found in the copyUsersFrom entity. Default is false.

Errors