Get trigger bindings

Retrieve the actions that are bound to a trigger. Once an action is created and deployed, it must be attached (i.e. bound) to a trigger so that it will be executed as part of a flow. The list of actions returned reflects the order in which they will be executed during the appropriate flow.

GET https://{tenantDomain}/api/v2/actions/triggers/{triggerId}/bindings

C#

C#

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

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.Triggers.Bindings.ListAsync(
            triggerId: ActionTriggerTypeEnum.PostLogin,
            request: new ListActionTriggerBindingsRequestParameters {
                Page = 1,
                PerPage = 1
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &triggers.ListActionTriggerBindingsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
    }
    mgmt.Actions.Triggers.Bindings.List(
        context.TODO(),
        "triggerId",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.actions.triggers.types.ListActionTriggerBindingsRequestParameters;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;

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

        client.actions().triggers().bindings().list(
            ActionTriggerTypeEnum.POST_LOGIN,
            ListActionTriggerBindingsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;
use Auth0\SDK\API\Management\Actions\Triggers\Bindings\Requests\ListActionTriggerBindingsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->triggers->bindings->list(
    ActionTriggerTypeEnum::PostLogin->value,
    new ListActionTriggerBindingsRequestParameters([
        'page' => 1,
        'perPage' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.actions.triggers.bindings.list(
    trigger_id="post-login",
    page=1,
    per_page=1,
)

require "auth0"

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

client.actions.triggers.bindings.list(
  trigger_id: "post-login",
  page: 1,
  per_page: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.triggers.bindings.list("triggerId", {
        page: 1,
        perPage: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.triggers.bindings.list("triggerId", {
        page: 1,
        perPage: 1,
    });
}
main();

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

200

{
  "total": 1,
  "page": 0,
  "per_page": 20,
  "bindings": [
    {
      "id": "4a881e22-0562-4178-bc91-b0f2b321dc13",
      "display_name": "my-action-1",
      "action": {
        "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
        "name": "my-action",
        "supported_triggers": [
          {
            "version": "<string>",
            "status": "<string>",
            "runtimes": [
              "<string>"
            ],
            "default_runtime": "<string>",
            "compatible_triggers": [
              {
                "version": "<string>"
              }
            ]
          }
        ],
        "all_changes_deployed": false,
        "created_at": "2021-01-01T00:00:00.000Z",
        "updated_at": "2021-01-01T00:00:00.000Z",
        "code": "module.exports = () => {}",
        "dependencies": [
          {
            "name": "<string>",
            "version": "<string>",
            "registry_url": "<string>"
          }
        ],
        "runtime": "node22",
        "secrets": [
          {
            "name": "mySecret",
            "updated_at": "2021-01-01T00:00:00.000Z"
          }
        ],
        "deployed_version": {
          "id": "12a3b9e6-06e6-4a29-96bf-90c82fe79a0d",
          "action_id": "910b1053-577f-4d81-a8c8-020e7319a38a",
          "code": "module.exports = () => {}",
          "dependencies": [
            {
              "name": "<string>",
              "version": "<string>",
              "registry_url": "<string>"
            }
          ],
          "deployed": true,
          "runtime": "node22",
          "secrets": [
            {
              "name": "mySecret",
              "updated_at": "2021-01-01T00:00:00.000Z"
            }
          ],
          "status": "built",
          "number": 1,
          "errors": [
            {
              "id": "<string>",
              "msg": "<string>",
              "url": "<string>"
            }
          ],
          "action": {
            "id": "910b1053-577f-4d81-a8c8-020e7319a38a",
            "name": "my-action",
            "supported_triggers": [
              {
                "version": "<string>",
                "status": "<string>",
                "runtimes": [
                  "<string>"
                ],
                "default_runtime": "<string>",
                "compatible_triggers": [
                  {
                    "version": "<string>"
                  }
                ]
              }
            ],
            "all_changes_deployed": false,
            "created_at": "2021-01-01T00:00:00.000Z",
            "updated_at": "2021-01-01T00:00:00.000Z"
          },
          "built_at": "2021-01-01T00:00:00.000Z",
          "created_at": "2021-01-01T00:00:00.000Z",
          "updated_at": "2021-01-01T00:00:00.000Z",
          "supported_triggers": [
            {
              "version": "<string>",
              "status": "<string>",
              "runtimes": [
                "<string>"
              ],
              "default_runtime": "<string>",
              "compatible_triggers": [
                {
                  "version": "<string>"
                }
              ]
            }
          ],
          "modules": [
            {
              "module_id": "<string>",
              "module_name": "<string>",
              "module_version_id": "<string>",
              "module_version_number": 123
            }
          ]
        },
        "installed_integration_id": "7d2bc0c9-c0c2-433a-9f4e-86ef80270aad",
        "integration": {
          "id": "8e9fe2d0-a2fc-4c8c-9e35-dae5afadb70b",
          "catalog_id": "awesome-auth0-integration",
          "url_slug": "awesome-auth0-integration-slug",
          "partner_id": "b8575c12-8d9d-4b5c-b28e-671fe9d39029",
          "name": "Example Auth0 integration",
          "description": "An awesome Auth0 integration",
          "short_description": "Awesome Auth0 integration",
          "logo": "<string>",
          "feature_type": "action",
          "terms_of_use_url": "<string>",
          "privacy_policy_url": "<string>",
          "public_support_link": "<string>",
          "current_release": {
            "id": "<string>",
            "trigger": {
              "version": "<string>",
              "status": "<string>",
              "runtimes": [
                "<string>"
              ],
              "default_runtime": "<string>",
              "compatible_triggers": [
                {
                  "version": "<string>"
                }
              ]
            },
            "semver": {
              "major": 1,
              "minor": 1
            },
            "required_secrets": [
              {
                "name": "<string>",
                "required": true,
                "optional": true,
                "label": "<string>",
                "description": "<string>",
                "default_value": "<string>",
                "placeholder": "<string>",
                "options": [
                  {
                    "value": "<string>",
                    "label": "<string>"
                  }
                ]
              }
            ],
            "required_configuration": [
              {
                "name": "<string>",
                "required": true,
                "optional": true,
                "label": "<string>",
                "description": "<string>",
                "default_value": "<string>",
                "placeholder": "<string>",
                "options": [
                  {
                    "value": "<string>",
                    "label": "<string>"
                  }
                ]
              }
            ]
          },
          "created_at": "2021-06-21T15:47:29.072Z",
          "updated_at": "2021-06-21T15:47:29.072Z"
        },
        "status": "built",
        "built_at": "2021-01-01T00:00:00.000Z",
        "deploy": false,
        "modules": [
          {
            "module_id": "<string>",
            "module_name": "<string>",
            "module_version_id": "<string>",
            "module_version_number": 123
          }
        ]
      },
      "created_at": "2021-01-01T00:00:00.000Z",
      "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.

パスパラメータ

triggerId · enum<string> · 必須

An actions extensibility point.

利用可能なオプション: 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

クエリパラメータ

page · integer

Use this field to request a specific page of the list results.

per_page · integer

The maximum number of results to be returned in a single request. 20 by default

レスポンス

200

application/json

The bindings were retrieved.

total · number · デフォルト: 1

The total result count.

page · number · デフォルト: 0

Page index of the results being returned. First page is 0.

per_page · number · デフォルト: 20

Number of results per page.

bindings · object[]

The list of actions that are bound to this trigger in the order in which they will be executed.

Show child attributes