Auth & Accounts
Login, session, device flow, user, role, and API Key.
Read the current browser or Bearer login status
Read the current browser or Bearer login status
Check if the administrator key is configured
Check if the administrator key is configured
Establish a recovery session with an administrator key
It is used for the first administrator recovery, recovery login when there is no account, and permission recovery.
Establish an account session by using the email password
Ordinary account and administrator account unified use this 1 portal login.
Clean up the current browser session
Clean up the current browser session
Read account invitation metadata
Returns the invited email, display name, 24-hour expiry, and optional acceptance time without exposing the stored token hash. Regenerating an invitation immediately invalidates its older link.
Accept an account invitation and set the initial password
Accepts the one-time invitation, sets the password, and revokes the account's existing browser sessions.
Create Device Login Request
CLI, Desktop, and Web first call this endpoint to obtain the device code, user code, and browser approval address,
Poll device flow results and exchange for API Key
Continue to poll by `intervalSeconds` when returning to `authorization_pending`;
Approve a device login in the browser
Approve a device login in the browser
Deny device login once in browser
Deny device login once in browser
Read current account information
Read current account information
Update current account information
Display name changes update both the authentication account and user profile and survive login and session renewal. Updating only an avatar, email, or password preserves the saved name.
List currently manageable API Keys
List currently manageable API Keys
Create a new API Key
Create a new API Key
Undo a API key
Undo a API key
List permission groups and definitions
List permission groups and definitions
List all global roles
List all global roles
Create a custom role
Create a custom role
Update role name, description, or permissions
Update role name, description, or permissions
Delete a custom role
Delete a custom role
List accounts and aggregate permissions summary
List accounts and aggregate permissions summary
Invite a new user
Invite a new user
Regenerate an invitation link for an existing invited user
Regenerate an invitation link for an existing invited user
Update a user's mailbox, display name, temporary password, or start/stop status
Update a user's mailbox, display name, temporary password, or start/stop status
Override the role collection for the specified user
Override the role collection for the specified user