Create Employee

post

https://connect.digits.com/v1/organization/employee

Create a new employee binding. The user must already exist (either
provisioned via SSO or as an existing Digits user). This operation
is synchronous.

Requires scope: organization:sync.

Body Params

Request to create an employee binding. The referenced user must already exist.
organizationRole is required. Optionally provide entity access
(entityRole, entities, or both), client access (clientRole, clients,
or both), or both. entityRole and clientRole are employee-level defaults:
they are stored on the employee row for future entities or client entities,
and applied to current access unless explicit entities or clients entries
override them.

userId

string

User's Digits-assigned ID (provide userId or userExternalId).

userExternalId

string

User's caller-assigned ID (provide userId or userExternalId).

organizationRole

string

required

The employee's role within the organization.

entities

array of objects

Explicit role assignments on the organization's own entities. When entityRole is set, these override that default for named entities.

entities

clients

array of objects

Explicit role assignments on client entities. When clientRole is set, these override that default for named clients or entities.

clients

entityRole

string

Employee-level default role for the organization's own entities. Stored for future entities and applied to existing entities unless entities provides overrides.

clientRole

string

Employee-level default role for client entities. Stored for future client entities and applied to current client access unless clients provides overrides.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response