API ReferenceEntityUser

Create entity user

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Request

This endpoint expects an object.
foreignIdstringOptional
The ID used to identify this user in your system.
emailstringOptional
namestringOptional
roleslist of stringsOptional

List of roles. A role can be any string. For example: “payer”, “approver”, “viewer”

Response

This endpoint returns an object.
idstring
roleslist of strings
createdAtdatetime
updatedAtdatetime
foreignIdstring or null
The ID used to identify this user in your system.
emailstring or null
namestring or null

Errors