Set an execution

Set an execution to call a previously defined target or include the targets of a previously defined execution.

application/json

application/grpc

application/grpc-web+proto

Request Body required

condition object

Defines the condition type and content of the condition for execution.

request object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function object

Condition-type to execute if function is used, replaces actions v1.

name string

event object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets object[]
Ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
request object
Condition-type to execute if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
response object
Condition-type to execute on response if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
function object
Condition-type to execute if function is used, replaces actions v1.
name string
event object
Condition-type to execute if an event is created in the system.
event string
Possible values: non-empty and <= 1000 characters
Event name as condition.
group string
Possible values: non-empty and <= 1000 characters
Event group as condition, all events under this group.
all boolean
all events as condition.
]

Request Body required

condition object

Defines the condition type and content of the condition for execution.

request object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function object

Condition-type to execute if function is used, replaces actions v1.

name string

event object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets object[]
Ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
request object
Condition-type to execute if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
response object
Condition-type to execute on response if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
function object
Condition-type to execute if function is used, replaces actions v1.
name string
event object
Condition-type to execute if an event is created in the system.
event string
Possible values: non-empty and <= 1000 characters
Event name as condition.
group string
Possible values: non-empty and <= 1000 characters
Event group as condition, all events under this group.
all boolean
all events as condition.
]

Request Body required

condition object

Defines the condition type and content of the condition for execution.

request object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

response object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available service and endpoint as condition.

function object

Condition-type to execute if function is used, replaces actions v1.

name string

event object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

targets object[]
Ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
request object
Condition-type to execute if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
response object
Condition-type to execute on response if a request on the defined API point happens.
method string
Possible values: non-empty and <= 1000 characters
GRPC-method as condition.
service string
Possible values: non-empty and <= 1000 characters
GRPC-service as condition.
all boolean
All calls to any available service and endpoint as condition.
function object
Condition-type to execute if function is used, replaces actions v1.
name string
event object
Condition-type to execute if an event is created in the system.
event string
Possible values: non-empty and <= 1000 characters
Event name as condition.
group string
Possible values: non-empty and <= 1000 characters
Event group as condition, all events under this group.
all boolean
all events as condition.
]

Responses

• 200
• 403
• 404
• default

---

Execution successfully set

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object
Details provide some base information (such as the last change date) of the execution.
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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-17T09:46:05.472Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
Details provide some base information (such as the last change date) of the execution.
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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-17T09:46:05.472Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
Details provide some base information (such as the last change date) of the execution.
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
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-17T09:46:05.472Z",
    "resourceOwner": "69629023906488334"
  }
}

Returned when the user does not have permission to access the resource.

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"
    }
  ]
}

Returned when the resource does not exist.

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"
    }
  ]
}

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"
    }
  ]
}

PUT /v3alpha/executions

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "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

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

python / requests

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

go / native

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

nodejs / axios

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

csharp / RestSharp

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

php / cURL

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

java / OkHttp

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'

powershell / RestMethod

curl -L -X PUT 'https://$CUSTOM-DOMAIN/v3alpha/executions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "condition": {
    "request": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "response": {
      "method": "/zitadel.session.v2beta.SessionService/ListSessions",
      "service": "zitadel.session.v2beta.SessionService",
      "all": true
    },
    "function": {
      "name": "string"
    },
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  },
  "targets": [
    {
      "target": "string",
      "include": {
        "request": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "response": {
          "method": "/zitadel.session.v2beta.SessionService/ListSessions",
          "service": "zitadel.session.v2beta.SessionService",
          "all": true
        },
        "function": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      }
    }
  ]
}'