Returns the custom domains of an instance
Returns the custom domains of an instance
Path Parameters
- instanceId string required
list limitations and ordering
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
query object
- sortingColumn the field the result is sorted
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
queries object[]
Request Body required
query object
- sortingColumn the field the result is sorted
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
queries object[]
Request Body required
query object
- sortingColumn the field the result is sorted
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
queries object[]
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": true
}
]
}
- Schema
- Example (from schema)
Schema
details object
- sortingColumn string
Possible values: [
DOMAIN_FIELD_NAME_UNSPECIFIED
,DOMAIN_FIELD_NAME_DOMAIN
,DOMAIN_FIELD_NAME_PRIMARY
,DOMAIN_FIELD_NAME_GENERATED
,DOMAIN_FIELD_NAME_CREATION_DATE
]Default value:
DOMAIN_FIELD_NAME_UNSPECIFIED
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2023-05-11"
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2023-05-11",
"changeDate": "2023-05-11",
"resourceOwner": "69629023906488334"
},
"domain": "zitadel.com",
"primary": true,
"generated": 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
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
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
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
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
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /instances/:instanceId/domains/_search
Request
Request
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'
curl -L -X POST 'https://$ZITADEL_DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"query": {
"offset": "0",
"limit": 100,
"asc": true
},
"sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
"queries": [
{
"domainQuery": {
"domain": "string",
"method": "TEXT_QUERY_METHOD_EQUALS"
},
"generatedQuery": {
"generated": true
},
"primaryQuery": {
"primary": true
}
}
]
}'