List roles, inventory access rules, and permission metadata
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
Requires an authenticated browser session with the roles.manage permission. Rules grant additional item-specific permissions when every condition matches.
adminSessionauthjs.session-token<token>Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.
X-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
uuidRoles, rules, and metadata used to administer granular access
application/json- response
roles*array<>rules*array<>permissionGroups*array<>resourceRulePermissions*array<>curl -X GET 'https://example.com/api/access/roles'{ "roles": [ { "key": "editor", "name": "string", "description": "string", "permissions": [ "inventory.read" ], "isSystem": true, "memberCount": 0, "createdBy": "string", "updatedBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "rules": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "roleKey": "editor", "permissions": [ "inventory.update" ], "conditions": [ { "field": "status", "operator": "equals", "value": "string" } ], "enabled": true, "priority": 0, "createdBy": "string", "updatedBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "permissionGroups": [ { "key": "string", "label": "string", "description": "string", "permissions": [ { "key": "inventory.read", "label": "string", "description": "string" } ] } ], "resourceRulePermissions": [ "inventory.update" ]}