API Reference

Update Client Employee

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

Replace an employee's access within a client organization. Both the user
and client organization must already exist. This operation is synchronous
and declarative: the employee's organization role and entity-role bindings
within this client organization are replaced by the request body.

Requires scope: organization:sync.

Body Params

Request to replace an employee's access within a client organization. The referenced user
and client organization must already exist. organizationRole is required. Entity access is
replaced by the provided default entity role (entityRole) and explicit per-entity role
assignments (entities). When entityRole is set, entities override that default for named
entities. When both are omitted, the employee has no entity access within this client organization.

string

Target client organization's Digits-assigned ID (provide clientOrganizationId or clientOrganizationExternalId).

string

Target client organization's caller-assigned ID (provide clientOrganizationId or clientOrganizationExternalId).

string

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

string

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

string
required

The user's role within the client organization.

entities
array of objects

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

entities
string

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

Responses

Updated 3 days ago

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

Updated 3 days ago