Custom Roles
Last updated: 2026-10-02
Build your own permission sets, down to the level of "which API can be called" — then assign them to users or API Keys.
Custom Roles
A Custom Role is a "permission set" that you name yourself — like "Accounting Staff" or "Dev Team" — where you decide exactly which functions (APIs) of the system anyone assigned this role can call. You can then attach this role directly to a User or an API Key, instead of setting permissions one person at a time.
Screenshot
| Number | What it is |
|---|---|
| 1 | "Add Role" button and multi-select delete button |
| 2 | Columns: Role name, Description, Tags |
| 3 | Search box |
What you can do here
Create a new role
Click "Add Role" and fill in:
| Number | What it is |
|---|---|
| 1 | Role Information — role name (required), description, tags |
| 2 | Search permissions box |
| 3 | "Selected / Total" counter |
| 4 | List of permission groups (organized by the system's function groups), with checkboxes to select an entire group or individual items |
- Role name (required) — give it a meaningful name, e.g. "Accounting Team - View Only"
- Description and Tags (optional) — help you categorize and find it later
- Select permissions — use the search box to filter for the functions you need, then check items one at a time, or check a group heading to select the whole group at once
Understand this before setting up a role
- Roles here are a fine-grained list of individual functions (APIs), not broad permission levels like "Admin"/"Staff" — you must choose exactly which functions to allow. If a function isn't checked, anyone assigned this role will not be able to use it at all.
- Only select the permissions actually needed for the job (the "least privilege" principle) to reduce security risk.
Edit an existing role
Click a role's name in the list to open it for editing. The form automatically loads and checks the permissions that were previously selected. Make your changes and save immediately (if you leave the page without saving, the system will always ask you to confirm first).
Delete a role
Select the role(s) you want to remove (you can select multiple at once) and click delete — the system will always ask for confirmation before actually deleting, since deletion cannot be undone.
Good to know
- If any users or API Keys are currently attached to this role, check first before deleting to make sure it won't affect their access.