Skip to content

Access and organization

Users, groups, identity providers, SSO enforcement, SCIM settings, API tokens, source keys, your organization, plan entitlements and the audit log.

The permission column lists what the route checks. An API token needs one of them as a scope. Where a route lists several, the route checks them for different parts of the request.

Method Path Permission
GET /api/audit-logs audit:read
GET /api/group-mappings settings:read
POST /api/group-mappings settings:write
DELETE /api/group-mappings/:id settings:write
GET /api/groups users:read
POST /api/groups users:write
PATCH /api/groups/:id users:write
DELETE /api/groups/:id users:write
GET /api/groups/:id/members users:read
POST /api/groups/:id/members users:write
DELETE /api/groups/:id/members/:userId users:write
GET /api/identity-providers settings:read
POST /api/identity-providers settings:write
PATCH /api/identity-providers/:id settings:write
DELETE /api/identity-providers/:id settings:write
GET /api/scim/settings settings:read
PUT /api/scim/settings settings:write
GET /api/scim/tokens settings:read
POST /api/scim/tokens settings:write
DELETE /api/scim/tokens/:id settings:write
GET /api/source-keys settings:read
POST /api/source-keys settings:write
DELETE /api/source-keys/:id settings:write
POST /api/sso/break-glass/end settings:write
GET /api/sso/enforcement settings:read, settings:write
POST /api/sso/enforcement/disable settings:write
POST /api/sso/enforcement/enable settings:write
GET /api/tenant settings:read
PATCH /api/tenant settings:write
GET /api/tenant/device-counts settings:read
GET /api/tenant/email-settings settings:read
PATCH /api/tenant/email-settings settings:write
GET /api/tenant/entitlements settings:read
GET /api/tenant/staff-access settings:read, settings:write
POST /api/tenant/staff-access/grants/:id/approve settings:write
POST /api/tenant/staff-access/grants/:id/deny settings:write, settings:read
GET /api/tenant/staff-access/grants/:id/requests settings:read
POST /api/tenant/staff-access/grants/:id/revoke settings:write, settings:read
PUT /api/tenant/staff-access/policy settings:write
GET /api/tokens settings:read
POST /api/tokens settings:write
DELETE /api/tokens/:id settings:write
GET /api/users users:read
GET /api/users/:id/groups users:read
PATCH /api/users/:id/role users:write
PATCH /api/users/:id/status users:write
GET /api/workers/health security:read

This page is generated from the API route inventory. 47 endpoints.