Get Action By ID

GET 
/actions/: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.

Request

Path Parameters

id stringrequired

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

A successful response.

application/json

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 (string)

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

Example (from schema)

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:08.200Z",
      "changeDate": "2024-11-22T16:27:08.200Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ACTION_STATE_UNSPECIFIED",
    "name": "log context",
    "script": "function log(context, calls){console.log(context)}",
    "timeout": "string",
    "allowedToFail": true
  }
}

application/grpc

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 (string)

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

Example (from schema)

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:08.200Z",
      "changeDate": "2024-11-22T16:27:08.200Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ACTION_STATE_UNSPECIFIED",
    "name": "log context",
    "script": "function log(context, calls){console.log(context)}",
    "timeout": "string",
    "allowedToFail": true
  }
}

application/grpc-web+proto

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 (string)

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

Example (from schema)

{
  "action": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:08.201Z",
      "changeDate": "2024-11-22T16:27:08.201Z",
      "resourceOwner": "69629023906488334"
    },
    "state": "ACTION_STATE_UNSPECIFIED",
    "name": "log context",
    "script": "function log(context, calls){console.log(context)}",
    "timeout": "string",
    "allowedToFail": true
  }
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...