Skip to main content

Get Domain Settings

GET 
https://$CUSTOM-DOMAIN/admin/v1/policies/domain

Returns the domain settings configured as default on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation..

Responses​

default domain policy

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 (string)
    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

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/policies/domain' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
ResponseClear

Click the Send API Request button above and see the response here!