Auth

Register

Create a password account.

Needs both self-registration and password login enabled; otherwise 403. When the allowed email domains list is set, an email address in one of those domains is required.

If email verification is required, the request includes an email address and the server has SMTP configured, the account activates when its owner follows the emailed link and gets the default self-registration role. Otherwise it stays pending until an administrator approves it with a role. The response is the same whether or not the username or email was taken.

post/auth/register/

Request

The document declares no server URL.
Auth: none declared

Request body

usernamestring required

Unique login name

passwordstring required

Plaintext password (policy: min 12 chars, 3+ character classes, at most 72 bytes UTF-8)

emailstring email nullable

Optional email address

Example request

{
  "username": "jdoe",
  "email": "jdoe@example.com"
}

Response

Successful Response

messagestring required

next_step'verify_email' | 'await_approval' nullable

Post-registration step for the client to display: 'verify_email' when a verification email was (or, for a swallowed collision, would have been) sent; 'await_approval' for the admin-approval path. None on non-register responses.

Changes

No recorded changes to this operation across all 50 revisions of this API.