Skip to main content

Get Domain Settings for Organization​

Get the domain settings configured on a specific organization. If the organization doesn't have a custom setting, the default will be returned. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation.

Path Parameters
  • orgId string required
Responses

domain policy of the org or the default policy if not customized

Schema
  • policy object
  • 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
  • userLoginMustBeDomain boolean

    the username has to end with the domain of its organization

  • isDefault boolean

    defines if the organization's admin changed the policy

  • 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

  • isDefault deprecated: is_default is also defined in zitadel.policy.v1.DomainPolicy
Loading...