Create Client Employee

post

https://connect.digits.com/v1/organization/client/{id}/employee

Create or reactivate a client employee's access to a client organization. Both the
user and client organization must already exist. This operation is synchronous.
If the client employee binding already exists and is active, the request fails with
AlreadyExists; use Update Client Employee to fully replace access for an
active employee binding. When reactivating a client employee, supplied roles are
applied and access omitted from the request is not removed.

Requires scope: organization:sync.

Path Params

string

required

Client organization's Digits-assigned ID.

Body Params

Request to create or reactivate an employee binding within a client organization.
The referenced user and client organization must already exist. If the employee
binding already exists and is active, use UpdateClientEmployeeRequest instead.

string

Client organization's Digits-assigned ID.

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

Role within the organization.

entities

array of objects

Explicit role assignments within this client's entities. When entityRole is set, these override that default for named entities.

entities

entityRole

string

Employee-level default role for this client's entities. Stored for future entities and applied to existing entities unless entities 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