Skip to main content

Get Domain Settings for Organization​

Create the domain settings configured on a specific organization. It will overwrite the settings specified on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation.

Path Parameters
  • orgId string required
Request Body required
  • userLoginMustBeDomain the username has to end with the domain of its organization (uniqueness is organization based)

    the username has to end with the domain of its organization

  • validateOrgDomains boolean

    defines if organization domains should be validated org count as validated automatically

  • smtpSenderAddressMatchesInstanceDomain boolean

    defines if the SMTP sender address domain should match an existing domain on the instance

Responses

domain policy created

Schema
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
POST /orgs/:orgId/policies/domain

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/admin/v1
Bearer Token
orgId — path required
Content-Type
Body required
{

  "userLoginMustBeDomain": true,

  "validateOrgDomains": true,

  "smtpSenderAddressMatchesInstanceDomain": true

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/orgs/:orgId/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'