Skip to main content

​
List users

GET /api/v1/users
Returns all users in the organisation. Requires read:users scope. Response 
{
  "data": [
    {
      "id": "user_uuid",
      "name": "Alex Chen",
      "email": "alex@company.com",
      "role": "member",
      "clearance_level": "C2",
      "effective_clearance": "C2",
      "status": "active",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ]
}

​
Invite a user

POST /api/v1/users/invite

{
  "email": "newuser@company.com",
  "role": "member"
}
The user receives an invitation email with a 72-hour activation link.

​
Update a user’s role

PATCH /api/v1/users/:id/role

{
  "role": "department_admin"
}
Valid roles: owner, domain_admin, department_admin, security_officer, member, auditor

​
Set clearance level

PATCH /api/v1/users/:id/clearance

{
  "clearance_level": "C3"
}
Pass "" to clear the override and revert to role default.

​
Deactivate a user

POST /api/v1/users/:id/deactivate
Immediately invalidates sessions and removes all memberships.

​
Reactivate a user

POST /api/v1/users/:id/reactivate

​
List Org Unit memberships for a user

GET /api/v1/users/:id/org-units

​
Add user to an Org Unit

POST /api/v1/org-units/:org_unit_id/members

{
  "user_id": "user_uuid",
  "role": "member"
}

​
Remove user from an Org Unit

DELETE /api/v1/org-units/:org_unit_id/members/:user_id