API ReferenceEntity GroupUser

Create Group User

Create entity user that will be added to all entities in the group. If a user with the same foreignId already exists, the user will be updated with the new information.

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.
foreignIdstringRequired

The ID used to identify this user in your system. This is a required field and needs to be unique for all users in the group.

emailstringOptional
namestringOptional
roleslist of stringsOptional

List of roles to assign to the user. A role can be any string. For example: “payer”, “approver”, “viewer” If not provided, the user will have no roles. Per entity roles will override these global roles.

entitieslist of objectsOptional

List of roles per entity. Useful for assigning roles to specific entities.

Response

This endpoint returns an object.
foreignIdstring

The ID used to identify this user in your system.

entitieslist of objects

List of roles per entity.

createdAtdatetime
updatedAtdatetime
emailstringOptional
namestringOptional

Errors