Target by ID​
Returns the target identified by the requested ID.
Path Parameters
unique identifier of the target.
- 200
- 403
- 404
- default
Target successfully retrieved
Schema
target object
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
Possible values: non-empty
and <= 1000 characters
restRequestResponse object
Possible values: non-empty
and <= 1000 characters
Timeout defines the duration until ZITADEL cancels the execution.
Set the execution to run asynchronously.
Define if any error stops the whole execution. By default the process continues as normal.
{
"target": {
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-03-27T06:43:19.739Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"url": "https://example.com/hooks/ip_check"
},
"restRequestResponse": {
"url": "https://example.com/hooks/ip_check"
},
"timeout": "10s",
"isAsync": true,
"interruptOnError": true
}
}
Schema
target object
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
Possible values: non-empty
and <= 1000 characters
restRequestResponse object
Possible values: non-empty
and <= 1000 characters
Timeout defines the duration until ZITADEL cancels the execution.
Set the execution to run asynchronously.
Define if any error stops the whole execution. By default the process continues as normal.
{
"target": {
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-03-27T06:43:19.739Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"url": "https://example.com/hooks/ip_check"
},
"restRequestResponse": {
"url": "https://example.com/hooks/ip_check"
},
"timeout": "10s",
"isAsync": true,
"interruptOnError": true
}
}
Schema
target object
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
Possible values: non-empty
and <= 1000 characters
restRequestResponse object
Possible values: non-empty
and <= 1000 characters
Timeout defines the duration until ZITADEL cancels the execution.
Set the execution to run asynchronously.
Define if any error stops the whole execution. By default the process continues as normal.
{
"target": {
"targetId": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-03-27T06:43:19.740Z",
"resourceOwner": "69629023906488334"
},
"name": "ip_allow_list",
"restWebhook": {
"url": "https://example.com/hooks/ip_check"
},
"restRequestResponse": {
"url": "https://example.com/hooks/ip_check"
},
"timeout": "10s",
"isAsync": true,
"interruptOnError": true
}
}
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"
}
]
}