API ReferenceEntityUser

Create entity user

POST

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Request

This endpoint expects an object.
foreignId
stringOptional
The ID used to identify this user in your system.
email
stringOptional
name
stringOptional
roles
list of stringsOptional
List of roles. A role can be any string. For example: "payer", "approver", "viewer"

Response

This endpoint returns an object
id
string
roles
list of strings
createdAt
datetime
updatedAt
datetime
foreignId
stringOptional
The ID used to identify this user in your system.
email
stringOptional
name
stringOptional