Skip to main content

Get Domain Policy​

Returns the domain policy (this policy is managed by the IAM administrator)

Header Parameters
  • x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Responses

A successful response.

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

Loading...