Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
maildomains

Create new mailbox in a specific maildomain.

post/api/v1.0/maildomains/{maildomain_pk}/mailboxes/

Path parameters

maildomain_pkstring uuid required

Request body

local_partstring required
alias_ofstring uuid

Response

The new mailbox with one extra field one_time_password if identity provider is keycloak.

idstring uuid required

primary key for the record as UUID

local_partstring required
domain_namestring required
is_identityboolean required

Whether this mailbox identifies a person (i.e. is not an alias or a group)

alias_ofstring uuid nullable

primary key for the record as UUID

created_atstring date-time required

date and time at which a record was created

updated_atstring date-time required

date and time at which a record was last updated

can_reset_passwordboolean required
last_accessed_atstring date-time nullable required

Most recent accessed_at across all mailbox accesses.

has_mandatory_totpboolean nullable required

Whether the Keycloak user backing this mailbox carries the KEYCLOAK_TOTP_ROLE_ID realm role. null when the feature is disabled or the role id isn't configured.

one_time_passwordstring nullable required

Fake method just to make the OpenAPI schema valid.