Documentation
Users and Roles

Profile and security

Your account details, two-factor authentication, API keys, and signed-in devices.

Open the profile icon in the top bar, then Profile. The page is /UI/users/view/<id> and has three tabs.

TabWhat it holds
ProfileRead-only summary: photo, roles, contact details, working hours, About Me, Details, Contributions, and Skills.
My AccountEditable account and detail fields.
SecurityTwo-factor authentication, password reset, API keys, and authenticated devices.

My Account

My Account tab

SectionFields
AccountUsername, Email, Phone Extension, Phone Number, Job Title, Employee ID
DetailsFirst Name, Last Name, Gender, Joining Date, Working Hours Start and End, Country, Timezone, Status, Languages, Notes

Edit the fields and click Edit to save. Custom fields added under Forms for Users appear here too.

Two-factor authentication

The Security tab shows the state of two-factor authentication (Disabled or enabled). It uses an authenticator app (TOTP).

  1. Open Security.
  2. Click Enroll 2FA and follow the prompts in your authenticator app.
  3. After enrollment, sign-in asks for the code from the app.

Reset your password

  1. Open Security.
  2. Enter New Password and New Password Confirm.
  3. Click Submit.

The password must follow the rules on the Users page.

API keys

An API key lets a script or integration call the REST API as you, without your password. See API Docs.

Create API Key dialog

Create a key

  1. In Security, click the + in the API Keys panel.
  2. Enter a Name, an Expires At date, and your Current Password.
  3. Click Create.
  4. Copy the key when it is shown and store it somewhere safe.

Use a key

Send the key in the X-API-Key request header on every call:

curl -X GET "https://<host>/api/users" \
  -H "Accept: application/json" \
  -H "X-API-Key: sb_your_api_key_here"

The panel shows this example with your own host.

Manage keys

Each key in the list shows its name, the last characters of the key, whether it is Enabled, and its expiry, with the time remaining while it is valid.

ControlEffect
Pause iconDisables the key without deleting it.
Red binDeletes the key.

A key acts with your permissions. Give each integration its own key with the shortest expiry that works, and delete keys you no longer use.

Authenticated devices

The Authenticated Devices panel lists the browsers and clients that signed in to your account: the device name, how it signed in (for example credentials), the address, and the last time it was seen. Click the red bin to remove a device you do not recognize.