Get Domain Settings
GET/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​
- 200
- 403
- 404
- default
default domain policy
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:14.302Z",
"changeDate": "2024-11-22T09:27:14.302Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:14.302Z",
"changeDate": "2024-11-22T09:27:14.302Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-22T09:27:14.302Z",
"changeDate": "2024-11-22T09:27:14.302Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}