Skip to main content
GET
Get effective role-permission matrix
Returns the permissions in force for each role in your organisation. For each role and permission, granted says whether the role holds it, and is_override says whether that value was set for your organisation rather than taken from the default.

Permission

Requires organisation_settings:read, which the Owner and Admin roles hold by default. A caller without it receives 403.

Role Names

role_permissions is keyed by these role values:

Changing Role Permissions

Anyone with organisation_settings:write changes role permissions in the Veridox dashboard. This is not available through the API.

Authorizations

x-api-key
string
header
required

Response

Role permissions retrieved successfully

role_permissions
object
required