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

string

Digits user ID (provide user_id or user_external_id).

string

Caller-assigned user ID.

string
required

The employee's role within the organization.

entities
array of objects

Per-entity bindings. Mutually exclusive with entity_role: provide one or the other, not both.

entities
clients
array of objects

Per-client bindings. Mutually exclusive with client_role: provide one or the other, not both.

clients
string

Role applied across all entities. Mutually exclusive with entities: provide one or the other, not both.

string

Role applied across all clients. Mutually exclusive with clients: provide one or the other, not both.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json