Get Action By ID​
Returns an action by id. Actions are custom code written in javascript, that can be run at a specified point/flow/trigger in ZITADEL.
Path Parameters
id string required
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.
Responses
- 200
- default
A successful response.
application/json
application/grpc
application/grpc-web+proto
Schema
Example (from schema)
Schema
action object
{
"action": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.477Z",
"changeDate": "2024-03-27T10:05:51.477Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
}
Schema
Example (from schema)
Schema
action object
{
"action": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.477Z",
"changeDate": "2024-03-27T10:05:51.477Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
}
Schema
Example (from schema)
Schema
action object
{
"action": {
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.478Z",
"changeDate": "2024-03-27T10:05:51.478Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
}
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"
}
]
}
GET /actions/:id
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
Request
Request
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
python / requests
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
go / native
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
nodejs / axios
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
ruby / Net::HTTP
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
csharp / RestSharp
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
php / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
java / OkHttp
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
powershell / RestMethod
curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'