Deactivate Action

POST 
https://$CUSTOM-DOMAIN/management/v1/actions/:id/_deactivate

Deactivate an existing action. The action will not be executed if configured in a flow. 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.

application/json

Bodyrequired

objectobject

application/grpc

Bodyrequired

objectobject

application/grpc-web+proto

Bodyrequired

objectobject

Responses

200

A successful response.

application/json

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

Authorization: oauth2

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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://$CUSTOM-DOMAIN/management/v1/actions/:id/_deactivate");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/management/v1

Auth

Bearer Token

Parameters

id — pathrequired

x-zitadel-orgid — header

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{}

ResponseClear

Click the Send API Request button above and see the response here!