Create Action
Create a new ZITADEL action. Actions are custom code written in javascript, that can be run at a specified point/flow/trigger in ZITADEL.
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- script string required
Possible values:
non-empty
and<= 2000 characters
Javascript code that should be executed
- timeout string
after which time the action will be terminated if not finished
- allowedToFail boolean
when true, the next action will be called even if this action fails
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- script string required
Possible values:
non-empty
and<= 2000 characters
Javascript code that should be executed
- timeout string
after which time the action will be terminated if not finished
- allowedToFail boolean
when true, the next action will be called even if this action fails
Request Body required
- name string required
Possible values:
non-empty
and<= 200 characters
- script string required
Possible values:
non-empty
and<= 2000 characters
Javascript code that should be executed
- timeout string
after which time the action will be terminated if not finished
- allowedToFail boolean
when true, the next action will be called even if this action fails
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
{
"details": {
"sequence": "2",
"creationDate": "2023-05-10",
"changeDate": "2023-05-10",
"resourceOwner": "69629023906488334"
},
"id": "string"
}
An unexpected error response.
- application/json
- application/grpc
- 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"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}