Actions を取得 - Auth0 Docs

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.ListAsync(
            new ListActionsRequestParameters {
                TriggerId = ActionTriggerTypeEnum.PostLogin,
                ActionName = "actionName",
                Deployed = true,
                Page = 1,
                PerPage = 1,
                Installed = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Actions.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.ListActionsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().list(
            ListActionsRequestParameters
                .builder()
                .triggerId(ActionTriggerTypeEnum.POST_LOGIN)
                .actionName("actionName")
                .deployed(true)
                .page(1)
                .perPage(1)
                .installed(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Actions\Requests\ListActionsRequestParameters;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->list(
    new ListActionsRequestParameters([
        'triggerId' => ActionTriggerTypeEnum::PostLogin->value,
        'actionName' => 'actionName',
        'deployed' => true,
        'page' => 1,
        'perPage' => 1,
        'installed' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.list(
    trigger_id="post-login",
    action_name="actionName",
    deployed=True,
    page=1,
    per_page=1,
    installed=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.list(
  trigger_id: "post-login",
  action_name: "actionName",
  deployed: true,
  page: 1,
  per_page: 1,
  installed: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.list({
        triggerId: "triggerId",
        actionName: "actionName",
        deployed: true,
        page: 1,
        perPage: 1,
        installed: true,
    });
}
main();

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

GET

https://{tenantDomain}/api/v2

actions

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.ListAsync(
            new ListActionsRequestParameters {
                TriggerId = ActionTriggerTypeEnum.PostLogin,
                ActionName = "actionName",
                Deployed = true,
                Page = 1,
                PerPage = 1,
                Installed = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    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,
        ),
    }
    mgmt.Actions.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.ListActionsRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.actions().list(
            ListActionsRequestParameters
                .builder()
                .triggerId(ActionTriggerTypeEnum.POST_LOGIN)
                .actionName("actionName")
                .deployed(true)
                .page(1)
                .perPage(1)
                .installed(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Actions\Requests\ListActionsRequestParameters;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->list(
    new ListActionsRequestParameters([
        'triggerId' => ActionTriggerTypeEnum::PostLogin->value,
        'actionName' => 'actionName',
        'deployed' => true,
        'page' => 1,
        'perPage' => 1,
        'installed' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.actions.list(
    trigger_id="post-login",
    action_name="actionName",
    deployed=True,
    page=1,
    per_page=1,
    installed=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.actions.list(
  trigger_id: "post-login",
  action_name: "actionName",
  deployed: true,
  page: 1,
  per_page: 1,
  installed: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.list({
        triggerId: "triggerId",
        actionName: "actionName",
        deployed: true,
        page: 1,
        perPage: 1,
        installed: true,
    });
}
main();

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

承認

Authorization

string

header

必須

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

クエリパラメータ

triggerId

enum<string>

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

deployed されている Actions のみを取得するためのオプションのフィルター。

page

integer

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

per_page

integer

サーバーが 1 回のレスポンスで返す結果の最大数。デフォルトは 20

installed

boolean

オプション。true の場合はインストール済みの Actions のみを返します。false の場合は custom Actions のみを返します。デフォルトではすべての Actions を返します。

レスポンス

Actions を取得しました。

actions

object[]

Actions のリスト。

Show child attributes

page

number

デフォルト:0

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

per_page

number

デフォルト:20

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

total

number

デフォルト:1

結果の総数。