Actions の取得

すべてのActionsを取得します。

GET https://{tenantDomain}/api/v2/actions/actions

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.ListActionsRequestParameters{
        TriggerId: management.String(
            "triggerId",
        ),
        ActionName: management.String(
            "actionName",
        ),
        Deployed: management.Bool(
            true,
        ),
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        Installed: management.Bool(
            true,
        ),
    }
    client.Actions.List(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.list({
        triggerId: "triggerId",
        actionName: "actionName",
        deployed: true,
        page: 1,
        perPage: 1,
        installed: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.actions.list({
        triggerId: "triggerId",
        actionName: "actionName",
        deployed: true,
        page: 1,
        perPage: 1,
        installed: true,
    });
}
main();

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

import requests

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

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/actions/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.get("https://{tenantDomain}/api/v2/actions/actions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "actions": [
    {
      "all_changes_deployed": false,
      "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>"
        }
      ],
      "deploy": false,
      "deployed_version": {
        "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"
      },
      "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
      "installed_integration_id": "7d2bc0c9-c0c2-433a-9f4e-86ef80270aad",
      "integration": {
        "catalog_id": "awesome-auth0-integration",
        "created_at": "2021-06-21T15:47:29.072Z",
        "current_release": {
          "id": "<string>",
          "required_configuration": [
            {
              "default_value": "<string>",
              "description": "<string>",
              "label": "<string>",
              "name": "<string>",
              "optional": true,
              "options": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ],
              "placeholder": "<string>",
              "required": true
            }
          ],
          "required_secrets": [
            {
              "default_value": "<string>",
              "description": "<string>",
              "label": "<string>",
              "name": "<string>",
              "optional": true,
              "options": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ],
              "placeholder": "<string>",
              "required": true
            }
          ],
          "semver": {
            "major": 1,
            "minor": 1
          },
          "trigger": {
            "compatible_triggers": [
              {
                "version": "<string>"
              }
            ],
            "default_runtime": "<string>",
            "runtimes": [
              "<string>"
            ],
            "status": "<string>",
            "version": "<string>"
          }
        },
        "description": "An awesome Auth0 integration",
        "feature_type": "action",
        "id": "8e9fe2d0-a2fc-4c8c-9e35-dae5afadb70b",
        "logo": "<string>",
        "name": "Example Auth0 integration",
        "partner_id": "b8575c12-8d9d-4b5c-b28e-671fe9d39029",
        "privacy_policy_url": "<string>",
        "public_support_link": "<string>",
        "short_description": "Awesome Auth0 integration",
        "terms_of_use_url": "<string>",
        "updated_at": "2021-06-21T15:47:29.072Z",
        "url_slug": "awesome-auth0-integration-slug"
      },
      "modules": [
        {
          "module_id": "<string>",
          "module_name": "<string>",
          "module_version_id": "<string>",
          "module_version_number": 123
        }
      ],
      "name": "my-action",
      "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"
    }
  ],
  "page": 0,
  "per_page": 20,
  "total": 1
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

triggerId · enum<string>

Actions の拡張ポイントです。 Actions の拡張ポイント。

利用可能なオプション: post-login, credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message, custom-phone-provider, custom-email-provider, password-reset-post-challenge, custom-token-exchange, event-stream, password-hash-migration, login-post-identifier, signup-post-identifier

actionName · string

取得する Action の名前。

deployed · boolean

デプロイ済みの Actions のみを取得するためのオプションのフィルター。

page · integer

一覧結果の特定のページをリクエストするには、このフィールドを使用します。

per_page · integer

1 回のレスポンスでサーバーから返される結果の最大数。既定値は 20 です

installed · boolean

オプション。true の場合はインストール済みの Actions のみを返します。false の場合はカスタム Actions のみを返します。既定ではすべての Actions を返します。

レスポンス

200

application/json

Actions を取得しました。

actions · object[]

Actions の一覧。

Show child attributes

page · number · デフォルト: 0

返される結果のページ インデックス。最初のページは 0 です。

per_page · number · デフォルト: 20

1 ページあたりの結果数。

total · number · デフォルト: 1

結果の総数。