Update Domain Settings

Update the domain settings configured as default on the instance. Domain settings specify how ZITADEL should handle domains, usernames, emails and validation. It affects all organizations that do not have overwritten settings.

application/json

Request Body required

• userLoginMustBeDomain boolean
• validateOrgDomains boolean
• smtpSenderAddressMatchesInstanceDomain boolean

application/grpc

Request Body required

• userLoginMustBeDomain boolean
• validateOrgDomains boolean
• smtpSenderAddressMatchesInstanceDomain boolean

application/grpc-web+proto

Request Body required

• userLoginMustBeDomain boolean
• validateOrgDomains boolean
• smtpSenderAddressMatchesInstanceDomain boolean

Responses

• 200
• 403
• 404
• default

---

default domain policy updated

application/json

• Schema
• Example (from schema)

---

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

  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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

• Schema
• Example (from schema)

---

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

  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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

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

  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

{
  "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

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

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"
    }
  ]
}

PUT /policies/domain

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL

https://$ZITADEL_DOMAIN/admin/v1

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/policies/domain' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "userLoginMustBeDomain": true,
  "validateOrgDomains": true,
  "smtpSenderAddressMatchesInstanceDomain": true
}'