List Trusted Domains

Lists Trusted Domains of the instance. By default the instance will be determined by the context of the request, e.g. the host header. You can optionally pass an InstanceID to list the domains of a specific instance. This requires additional permissions.

Required permissions:

iam.read
system.instance.read (if InstanceID is set)

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

instanceId?string

InstanceID is the unique ID of the instance whose Trusted Domains will be listed. If not set, the instance in the current context (e.g. identified by the host header) will be used. If an ID is set, the caller must have additional permissions.

pagination?

sortingColumn?string

Value in"TRUSTED_DOMAIN_FIELD_NAME_UNSPECIFIED" | "TRUSTED_DOMAIN_FIELD_NAME_DOMAIN" | "TRUSTED_DOMAIN_FIELD_NAME_CREATION_DATE"

filters?array<>

Filter the domains to be returned.

Response Body

`application/json`

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/ListTrustedDomains" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'

{
  "trustedDomain": [
    {
      "instanceId": "string",
      "creationDate": "2023-01-15T01:30:15.01Z",
      "domain": "string"
    }
  ],
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  }
}

{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`