Update User Access

Creates or updates explicit access grants on a user. The body is an access-configuration document whose attributes.assignments lists the grants to upsert: each names a principal (principal-type user or group, principal-id, and optionally principal-id-type to identify a user by email or employee-id, or a group by group-external-id) and the access-level to hold (view, update, manage or full-control). A principal that already has a grant is moved to the new level; principals not listed are left untouched; the request is idempotent. Per-principal problems (unknown principal, invalid level) do not fail the request: the valid subset is applied and every principal's outcome is reported in meta.results, with meta.status successful or completed-with-errors. The data array holds the assignments that were applied. The optional data.id is always the user's API id, whatever identifier the URL uses. Platform-created grants (the user's manager, the user's own view grant, the All Members and View Members Legacy Permission groups) are moved like any other principal; nothing guards them.

Required Scope

users:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The user's API id, or the value of the identifier named by identifier, as on the other v3 user endpoints.

Query Params
string

How id identifies the user: email or employee-id. Omit it for the user's API id.

Body Params

An access-configuration document. data.id is optional and must be the user's API id when present, whatever identifier the URL uses. assignments holds 1 to 1000 items.

data
object
required
Responses

500

The engine could not decide or apply the change for the resource (write-failed); nothing was applied. Retrying is safe.

503

Access configuration is temporarily unavailable (access-configuration-unavailable): the organization's ReBAC rollout mode could not be read, or the
deployment has no ReBAC engine (the detail says which). Retry later.

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