Users API
People and service accounts, invitations, roles and privileges.
Objects
A user is a person or a service account (kind), with a role, a status and effective privileges (privilege_adjustments are the per-user grants and removals on top of the role). Roles list each role's default privileges and the most it may hold on an account.
Typical use
Provision people from your HR system: POST /users (an invitation email with a 7-day link), then grant account permissions (PUT /entitlements/{userId}/{accountId}). Leavers: PATCH /users/{id} {"status": "disabled"} (with If-Match). Needs admin:users.
Endpoints
| Call | What it does | Scope |
|---|---|---|
GET/users | Users of the firm (people and service accounts) | users:read |
GET/users/{id} | One user with privileges | users:read |
POST/users | Invite a person (an email with a link) | admin:users |
PATCH/users/{id} | Change role or status (If-Match) | admin:users |
PUT/users/{id}/privileges/{privilege} | Grant, remove or reset one privilege | admin:users |
GET/roles | Roles, their default privileges and maximum account permissions | users:read |