Search Actions

POST 
/actions/_search

Returns a list of actions matching the query. Actions are custom code written in javascript, that can be run at a specified point/flow/trigger in ZITADEL.

Request

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

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted (string)

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

queries

object[]

Array [

actionIdQuery

object

id string

actionNameQuery

object

name string

method string

Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

Default value: TEXT_QUERY_METHOD_EQUALS

defines which text equality method is used

actionStateQuery

object

state string

Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

Default value: ACTION_STATE_UNSPECIFIED

current state of the action

]

application/grpc

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted (string)

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

queries

object[]

Array [

actionIdQuery

object

id string

actionNameQuery

object

name string

method string

Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

Default value: TEXT_QUERY_METHOD_EQUALS

defines which text equality method is used

actionStateQuery

object

state string

Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

Default value: ACTION_STATE_UNSPECIFIED

current state of the action

]

application/grpc-web+proto

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

sortingColumn the field the result is sorted (string)

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

queries

object[]

Array [

actionIdQuery

object

id string

actionNameQuery

object

name string

method string

Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

Default value: TEXT_QUERY_METHOD_EQUALS

defines which text equality method is used

actionStateQuery

object

state string

Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

Default value: ACTION_STATE_UNSPECIFIED

current state of the action

]

Responses

200

A successful response.

application/json

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

result

object[]

Array [

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)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-11-22T16:27:08.195Z"
  },
  "sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-11-22T16:27:08.195Z",
        "changeDate": "2024-11-22T16:27:08.195Z",
        "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

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

result

object[]

Array [

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)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-11-22T16:27:08.196Z"
  },
  "sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-11-22T16:27:08.196Z",
        "changeDate": "2024-11-22T16:27:08.196Z",
        "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

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

sortingColumn string

Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

Default value: ACTION_FIELD_NAME_UNSPECIFIED

result

object[]

Array [

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)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-11-22T16:27:08.196Z"
  },
  "sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2024-11-22T16:27:08.196Z",
        "changeDate": "2024-11-22T16:27:08.196Z",
        "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...