Users & Mailboxes #

Tenant Admins provision user identities and email addresses inside https://console.<your-domain> using control-backend endpoints (/v1/users, /v1/mailboxes, /v1/credentials/reset).

1. Create a User #

Create the directory user (POST /v1/users):

json
{
  "tenant": "<tenant-id>",
  "login": "alice@<your-domain>",
  "display_name": "Alice"
}

2. Create a Mailbox #

Bind a local-part on any verified domain (including the default <slug>.<base> subdomain or a verified custom domain) via POST /v1/mailboxes:

json
{
  "tenant": "<tenant-id>",
  "domain": "<your-domain>",
  "local_part": "alice"
}

Creating a mailbox automatically initializes the 6 standard SPECIAL-USE folders:

  • INBOX
  • Drafts (\Drafts)
  • Sent (\Sent)
  • Archive (\Archive)
  • Trash (\Trash)
  • Junk (\Junk)
NOTE

Both imapd and pop3d enforce strict owner isolation (tenant_id + owner_user_id): ownerless mailboxes are inaccessible and hidden by default.

3. Reset User Password #

If a user is locked out of Webmail (https://mail.<your-domain>), reset their primary password (POST /v1/credentials/reset):

json
{
  "tenant": "<tenant-id>",
  "login": "alice@<your-domain>",
  "new_password": "<TEMPORARY_STRONG_PASSWORD>"
}

identityd checks candidate passwords against the local breach dictionary (IDENTITY_BREACH_DATA_PATH) and hashes passwords using IDENTITY_PEPPER. Weak or breached passwords are rejected.