Skip to main content

Get the domain settings

GET 
/v2/settings/domain

Return the domain settings for the requested context

Request​

Query Parameters

    ctx.orgId string
    ctx.instance boolean

Responses​

OK

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

    changeDate date-time

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

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

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

    settings

    object

    loginNameIncludesDomain boolean

    the username has to end with the domain of its organization

    requireOrgDomainVerification boolean

    defines if organization domains should be verified upon creation, otherwise will be created already verified

    smtpSenderAddressMatchesInstanceDomain boolean

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

    resourceOwnerType resource_owner_type returns if the setting is managed on the organization or on the instance (string)

    Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

    Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

    resource_owner_type returns if the setting is managed on the organization or on the instance

Loading...