Actionをデプロイ

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

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

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Actions.Deploy(
        context.TODO(),
        "id",
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.deploy("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.deploy("id");
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions/{id}/deploy \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/actions/actions/{id}/deploy"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/actions/actions/{id}/deploy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/actions/actions/{id}/deploy")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/actions/actions/{id}/deploy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

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

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 バージョンで使用される Action Module とそのバージョンの一覧。

Show child attributes

number · number · デフォルト: 1

Action のバージョン一覧におけるこのバージョンのインデックス。

runtime · string · デフォルト: node22

Node.js ランタイム。例: node22

secrets · object[]

Action またはそのバージョンに含まれるシークレットの一覧。

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 によって更新されます。