Update Client Employee

put

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

Replace a client employee's access within a client organization. The client
employee binding must already exist and be active. If it does not exist or
is not active, the request fails with NotFound; use Create Client Employee
to create or reactivate access. This operation is synchronous and
declarative: the client 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.

clientOrganizationId

string

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

clientOrganizationExternalId

string

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

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

entityRole

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

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