Update an access role
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. Changing permissions revokes user-bound API tokens for members of this role. The built-in Admin role must retain every permission.
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.
key*stringStable role key.
^[a-z][a-z0-9_-]{0,63}$1 <= length <= 64X-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.
uuidapplication/json- body
1 <= propertiesname?string1 <= length <= 120description?stringlength <= 1000permissions?array<>items <= 30Role updated
application/json- response
role*curl -X PATCH 'https://example.com/api/access/roles/editor' \ -H 'Content-Type: application/json' \ -d '{}'{ "role": { "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" }}Delete an access role DELETE
Requires an authenticated browser session with the roles.manage permission. Built-in roles and roles assigned to users cannot be deleted; deleting a role also deletes its conditional inventory rules.
Create a conditional inventory access rule POST
Requires an authenticated browser session with the roles.manage permission. The rule grants its permissions to members of the selected role only for inventory items that match every condition.