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
id string
details object
sequence uint64
on 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-time
on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
state string
Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
name string
script string
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

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "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
id string
details object
sequence uint64
on 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-time
on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
state string
Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
name string
script string
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

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "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
id string
details object
sequence uint64
on 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-time
on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
state string
Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
name string
script string
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

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "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[]
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"
    }
  ]
}

GET /actions/:id

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL

https://$ZITADEL_DOMAIN/management/v1

Bearer Token

id — path required

x-zitadel-orgid — header

Accept

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/actions/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Get Action By ID​

Authorization

Request

Get Action By ID