Users
An identity that signs in or authenticates with a token, with a name, a language, and an appearance.
- API name:
users - Domain: Auth
- 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 | |
| Name | name | Text | Yes | Display name of the user |
email | Yes | Email address associated to the user (cannot be changed) | ||
| Email verified | emailVerified | Boolean | Yes | Whether the email address is verified |
| Permission role | roleId | Reference | The role whose lines give this user business access. Without a role the user sees only the personal module. | |
| Language | locale | Locale | The language to be used in the application | |
| Date format | maskDateFormat | Constant | Yes | How dates appear on screen for you. Stored values stay in ISO form. |
| Time format | maskTimeFormat | Constant | Yes | How clock times appear on screen for you. Stored values stay as HH:mm. |
| Decimals | viewDecimalPlaces | Whole Number | Decimal places on screen for you. Empty uses the organization value. | |
| Screen unit | viewUnitMode | Constant | Yes | Display unit in views for you. Organization uses the organization value. |
| Appearance | uiColorMode | Constant | Whether dark or light mode is used. Organization uses the organization value. | |
| Avatar | image | Image | Image used as user avatar | |
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Timestamp | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Timestamp | Yes | |
| Banned by | bannedBy | User | ||
| Banned at | bannedAt | Timestamp | When the user was banned from the platform | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Permission role roleId | Roles | reference |
Actions
What you can do with a record. Every action also sends the webhook event users.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new user. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this user. | App · WebMCP · API · MCP · CLI |
| Ban | ban | Ban the user and revoke active sessions. | App · WebMCP · API · MCP · CLI |
| Unban | unban | Restore access for a banned user. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this user and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.
| Action | API name |
|---|---|
| Ban | ban |
| Unban | unban |