BEbetagouv
maildomains

POST /api/v1.0/maildomains/

Changed on

ViewSet for listing MailDomains the user administers. Provides a top-level entry for mail domain administration. Endpoint: /maildomains/<maildomain_pk>/

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

Request body

namestring required
oidc_autojoinboolean

Create mailboxes automatically based on OIDC emails.

identity_syncboolean

Sync mailboxes to an identity provider.

custom_attributesunknown

Response

idstring uuid required

primary key for the record as UUID

namestring required
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

oidc_autojoinboolean

Create mailboxes automatically based on OIDC emails.

identity_syncboolean

Sync mailboxes to an identity provider.

custom_attributesunknown

Changes

  • ba0c140b76ddRevision changes
    • warning

      changed the pattern of the request property from ^[a-z0-9][a-z0-9.-]*[a-z0-9]$ to ^(?=.{2,253}$)(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)*$ (media type: application/json)

    • warning

      changed the pattern of the request property from ^[a-z0-9][a-z0-9.-]*[a-z0-9]$ to ^(?=.{2,253}$)(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)*$ (media type: multipart/form-data)

    • info

      the response's property pattern was changed from ^[a-z0-9][a-z0-9.-]*[a-z0-9]$ to ^(?=.{2,253}$)(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\.(?=[a-z0-9-]{1,63}(?:\.|$))[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)*$ for the status