Action をデプロイ

Action をデプロイします。Action をデプロイすると、その Action の新しい変更不可のバージョンが作成されます。Action が現在トリガーに関連付けられている場合、システムは新たにデプロイされた Action バージョンの実行を直ちに開始します。そうでない場合、その Action はそのフローに関連付けられた後でのみ、そのフローの一部として実行されます。

POST https://{tenantDomain}/api/v2/actions/actions/{id}/deploy

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Actions.DeployAsync(
            "id"
        );
    }

}

202

{
  "action": {
    "all_changes_deployed": false,
    "created_at": "2021-01-01T00:00:00.000Z",
    "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
    "name": "my-action",
    "supported_triggers": [
      {
        "compatible_triggers": [
          {
            "version": "<string>"
          }
        ],
        "default_runtime": "<string>",
        "runtimes": [
          "<string>"
        ],
        "status": "<string>",
        "version": "<string>"
      }
    ],
    "updated_at": "2021-01-01T00:00:00.000Z"
  },
  "action_id": "910b1053-577f-4d81-a8c8-020e7319a38a",
  "built_at": "2021-01-01T00:00:00.000Z",
  "code": "module.exports = () => {}",
  "created_at": "2021-01-01T00:00:00.000Z",
  "dependencies": [
    {
      "name": "<string>",
      "registry_url": "<string>",
      "version": "<string>"
    }
  ],
  "deployed": true,
  "errors": [
    {
      "id": "<string>",
      "msg": "<string>",
      "url": "<string>"
    }
  ],
  "id": "12a3b9e6-06e6-4a29-96bf-90c82fe79a0d",
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ],
  "number": 1,
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "updated_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "status": "built",
  "supported_triggers": [
    {
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ],
      "default_runtime": "<string>",
      "runtimes": [
        "<string>"
      ],
      "status": "<string>",
      "version": "<string>"
    }
  ],
  "updated_at": "2021-01-01T00:00:00.000Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string · 必須

Action の ID。

レスポンス

202

application/json

Action バージョンを作成するリクエストは受理されました。

action · object

このバージョンが属するアクション。

Show child attributes

action_id · string · デフォルト: 910b1053-577f-4d81-a8c8-020e7319a38a

このバージョンが属する Action の ID。

built_at · string<date-time> · デフォルト: 2021-01-01T00:00:00.000Z

このバージョンのビルドが正常に完了した時刻。

code · string · デフォルト: module.exports = () => {}

この Action の特定バージョンのソースコード。

created_at · string<date-time> · デフォルト: 2021-01-01T00:00:00.000Z

このバージョンが作成された時刻。

dependencies · object[]

この特定バージョンが依存するサードパーティ製 npm モジュールとそのバージョンの一覧。

Show child attributes

deployed · boolean · デフォルト: true

この特定バージョンが現在デプロイされているものかどうかを示します。

errors · object[]

このバージョンのビルド中に発生したエラー。

Show child attributes

id · string · デフォルト: 12a3b9e6-06e6-4a29-96bf-90c82fe79a0d

Action バージョンの一意の ID。

modules · object[]

このアクションバージョンで使用される Action Module とそのバージョンの一覧。

Show child attributes

number · number · デフォルト: 1

Action のバージョン一覧におけるこのバージョンの index。

runtime · string · デフォルト: node22

Node runtime。例: node22

secrets · object[]

Action またはそのバージョンに含まれる Secret の一覧。

Show child attributes

status · enum<string> · デフォルト: built

このバージョン固有のビルドステータス。

利用可能なオプション: pending, building, packaged, built, retrying, failed

supported_triggers · object[]

このバージョンがサポートするトリガーの一覧。現時点では、1 つのバージョンが対象にできるトリガーは一度に 1 つだけです。

Minimum array length: 1

Show child attributes

updated_at · string<date-time> · デフォルト: 2021-01-01T00:00:00.000Z

バージョンが更新された時刻。バージョンが外部から更新されることはありません。Action バージョンのビルド中に更新されるのは Auth0 のみです。