Get Domain Settings for Organization
Create the domain settings configured on a specific organization. It will overwrite the settings specified on the instance. Domain settings specify how ZITADEL should handle domains, in regards to usernames, emails and validation.
Path Parameters
- orgId string required
 
- application/json
 - application/grpc
 - application/grpc-web+proto
 
Request Body required
- userLoginMustBeDomain the username has to end with the domain of its organization (uniqueness is organization based)
the username has to end with the domain of its organization
 - 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
 
Request Body required
- userLoginMustBeDomain the username has to end with the domain of its organization (uniqueness is organization based)
the username has to end with the domain of its organization
 - 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
 
Request Body required
- userLoginMustBeDomain the username has to end with the domain of its organization (uniqueness is organization based)
the username has to end with the domain of its organization
 - 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
 
- 200
 - 403
 - 404
 - default
 
domain policy created
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}
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
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "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
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
An unexpected error response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}