Skip to main content

Delete an execution​

Delete an existing execution.

Request Body required
    condition object

    Unique identifier of the 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 string

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

    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

Execution successfully deleted

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
DELETE /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
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": "string",

    "event": {

      "event": "user.human.added",

      "group": "user.human",

      "all": true

    }

  }

}
Accept
curl / cURL
curl -L -X DELETE '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": "string",
    "event": {
      "event": "user.human.added",
      "group": "user.human",
      "all": true
    }
  }
}'