List targets​
List all matching targets. By default, we will return all targets of your instance. Make sure to include a limit and sorting for pagination.
Request Body required
- Array [
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
targetNameQuery object
Possible values: <= 200 characters
Defines the name of the target to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
inTargetIdsQuery object
the ids of the targets to include
Request Body required
- Array [
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
targetNameQuery object
Possible values: <= 200 characters
Defines the name of the target to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
inTargetIdsQuery object
the ids of the targets to include
Request Body required
- Array [
- ]
query object
list limitations and ordering.
Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
default is descending
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
the field the result is sorted.
queries object[]
Define the criteria to query for.
targetNameQuery object
Possible values: <= 200 characters
Defines the name of the target to query for.
Possible values: [TEXT_QUERY_METHOD_EQUALS
, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE
, TEXT_QUERY_METHOD_STARTS_WITH
, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE
, TEXT_QUERY_METHOD_CONTAINS
, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE
, TEXT_QUERY_METHOD_ENDS_WITH
, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE
]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
inTargetIdsQuery object
the ids of the targets to include
- 200
- 400
- 403
- 404
- default
A list of all targets matching the query
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
States by which field the results are sorted.
result object[]
The result contains the user schemas, which matched the queries.
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:36.064Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.064Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"interruptOnError": true
},
"restCall": {
"interruptOnError": true
},
"restAsync": {},
"timeout": "10s",
"endpoint": "https://example.com/hooks/ip_check"
}
]
}
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
States by which field the results are sorted.
result object[]
The result contains the user schemas, which matched the queries.
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:36.064Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.064Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"interruptOnError": true
},
"restCall": {
"interruptOnError": true
},
"restAsync": {},
"timeout": "10s",
"endpoint": "https://example.com/hooks/ip_check"
}
]
}
Schema
- Array [
- ]
details object
Details provides information about the returned result including total amount found.
the last time the projection got updated
Possible values: [FIELD_NAME_UNSPECIFIED
, FIELD_NAME_ID
, FIELD_NAME_CREATION_DATE
, FIELD_NAME_CHANGE_DATE
, FIELD_NAME_NAME
, FIELD_NAME_TARGET_TYPE
, FIELD_NAME_URL
, FIELD_NAME_TIMEOUT
, FIELD_NAME_ASYNC
, FIELD_NAME_INTERRUPT_ON_ERROR
]
Default value: FIELD_NAME_UNSPECIFIED
States by which field the results are sorted.
result object[]
The result contains the user schemas, which matched the queries.
ID is the read-only unique identifier of the target.
details object
Details provide some base information (such as the last change date) of the target.
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 last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Unique name of the target.
restWebhook object
Wait for response but response body is ignored, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
restCall object
Wait for response and response body is used, status is checked, call is sent as post.
Define if any error stops the whole execution. By default the process continues as normal.
Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.
Timeout defines the duration until ZITADEL cancels the execution.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-13T06:44:36.065Z"
},
"sortingColumn": "FIELD_NAME_UNSPECIFIED",
"result": [
{
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.065Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"interruptOnError": true
},
"restCall": {
"interruptOnError": true
},
"restAsync": {},
"timeout": "10s",
"endpoint": "https://example.com/hooks/ip_check"
}
]
}
invalid list query
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}