Roles
A set of organization permissions that says what may be done in each module and at which sites, teams, or companies.
- API name:
roles - Domain: Access and approvals
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Position | rank | Order rank | Yes | |
| Name | label | Text I18n | Display name of the role. Can be translated to multiple languages. | |
| Color | color | Color | Yes | |
| Permissions | permissions | Permissions | The role's permission lines: what it allows and where (table.key in module/entity). | |
| Description | description | Text Area I18n | An optional description of the role. Can be translated to multiple languages. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Actions
What you can do with a record. Every action also sends the webhook event roles.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new role. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this role. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this role. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this role again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this role from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this role to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this role and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |