Action を作成 - Auth0 Docs

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

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.CreateAsync(
            new CreateActionRequestContent {
                Name = "name",
                SupportedTriggers = new List<ActionTrigger>(){
                    new ActionTrigger {
                        Id = ActionTriggerTypeEnum.PostLogin
                    },
                }

            }
        );
    }

}

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.CreateActionRequestContent{
        Name: "name",
        SupportedTriggers: []*management.ActionTrigger{
            &management.ActionTrigger{
                Id: "id",
            },
        },
    }
    mgmt.Actions.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTrigger;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.CreateActionRequestContent;
import java.util.Arrays;

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

        client.actions().create(
            CreateActionRequestContent
                .builder()
                .name("name")
                .supportedTriggers(
                    Arrays.asList(
                        ActionTrigger
                            .builder()
                            .id(ActionTriggerTypeEnum.POST_LOGIN)
                            .build()
                    )
                )
                .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\CreateActionRequestContent;
use Auth0\SDK\API\Management\Types\ActionTrigger;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->create(
    new CreateActionRequestContent([
        'name' => 'name',
        'supportedTriggers' => [
            new ActionTrigger([
                'id' => ActionTriggerTypeEnum::PostLogin->value,
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, ActionTrigger

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

client.actions.create(
    name="name",
    supported_triggers=[
        ActionTrigger(
            id="post-login",
        )
    ],
)

require "auth0"

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

client.actions.create(
  name: "name",
  supported_triggers: [{
    id: "post-login"
  }]
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supportedTriggers: [
            {
                id: "id",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supportedTriggers: [
            {
                id: "id",
            },
        ],
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-action",
  "supported_triggers": [
    {
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ],
      "default_runtime": "<string>",
      "runtimes": [
        "<string>"
      ],
      "status": "<string>",
      "version": "<string>"
    }
  ],
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "registry_url": "<string>",
      "version": "<string>"
    }
  ],
  "deploy": false,
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ],
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "value": "mySecretValue"
    }
  ]
}
'

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

POST

https://{tenantDomain}/api/v2

actions

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

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.CreateAsync(
            new CreateActionRequestContent {
                Name = "name",
                SupportedTriggers = new List<ActionTrigger>(){
                    new ActionTrigger {
                        Id = ActionTriggerTypeEnum.PostLogin
                    },
                }

            }
        );
    }

}

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.CreateActionRequestContent{
        Name: "name",
        SupportedTriggers: []*management.ActionTrigger{
            &management.ActionTrigger{
                Id: "id",
            },
        },
    }
    mgmt.Actions.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ActionTrigger;
import com.auth0.client.mgmt.types.ActionTriggerTypeEnum;
import com.auth0.client.mgmt.types.CreateActionRequestContent;
import java.util.Arrays;

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

        client.actions().create(
            CreateActionRequestContent
                .builder()
                .name("name")
                .supportedTriggers(
                    Arrays.asList(
                        ActionTrigger
                            .builder()
                            .id(ActionTriggerTypeEnum.POST_LOGIN)
                            .build()
                    )
                )
                .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\CreateActionRequestContent;
use Auth0\SDK\API\Management\Types\ActionTrigger;
use Auth0\SDK\API\Management\Types\ActionTriggerTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->actions->create(
    new CreateActionRequestContent([
        'name' => 'name',
        'supportedTriggers' => [
            new ActionTrigger([
                'id' => ActionTriggerTypeEnum::PostLogin->value,
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, ActionTrigger

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

client.actions.create(
    name="name",
    supported_triggers=[
        ActionTrigger(
            id="post-login",
        )
    ],
)

require "auth0"

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

client.actions.create(
  name: "name",
  supported_triggers: [{
    id: "post-login"
  }]
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supportedTriggers: [
            {
                id: "id",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.actions.create({
        name: "name",
        supportedTriggers: [
            {
                id: "id",
            },
        ],
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/actions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-action",
  "supported_triggers": [
    {
      "compatible_triggers": [
        {
          "version": "<string>"
        }
      ],
      "default_runtime": "<string>",
      "runtimes": [
        "<string>"
      ],
      "status": "<string>",
      "version": "<string>"
    }
  ],
  "code": "module.exports = () => {}",
  "dependencies": [
    {
      "name": "<string>",
      "registry_url": "<string>",
      "version": "<string>"
    }
  ],
  "deploy": false,
  "modules": [
    {
      "module_id": "<string>",
      "module_name": "<string>",
      "module_version_id": "<string>",
      "module_version_number": 123
    }
  ],
  "runtime": "node22",
  "secrets": [
    {
      "name": "mySecret",
      "value": "mySecretValue"
    }
  ]
}
'

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

承認

Authorization

string

header

必須

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

ボディ

name

string

デフォルト:my-action

必須

action の名前。

supported_triggers

object[]

必須

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

Minimum array length: 1

Show child attributes

code

string

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

action のソースコード。

dependencies

object[]

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

Show child attributes

deploy

boolean

デフォルト:false

作成後に action をデプロイする場合は true。

modules

object[]

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

Show child attributes

runtime

string

デフォルト:node22

Node runtime。例: node22、デフォルトは node22

secrets

object[]

action または action のバージョンに含まれる secrets の一覧。

Show child attributes

レスポンス

Action が正常に作成されました。

all_changes_deployed

boolean

デフォルト:false

Action の内容がすべてデプロイされている場合は true。

built_at

string<date-time>

デフォルト:2021-01-01T00:00:00.000Z

この action が正常にビルドされた日時。

code

string

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

action のソースコード。

created_at

string<date-time>

デフォルト:2021-01-01T00:00:00.000Z

この action が作成された日時。

dependencies

object[]

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

Show child attributes

deploy

boolean

デフォルト:false

作成後にこの action をデプロイする場合は true。

deployed_version

object

現在デプロイされているアクションのバージョン。

Show child attributes

string

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

action の一意の ID。

installed_integration_id

string

デフォルト:7d2bc0c9-c0c2-433a-9f4e-86ef80270aad

installed_integration_id は InstalledIntegration エンティティへの外部キー参照です。

integration

object

連携は、パートナーが公開する自己完結型の機能単位を定義します。パートナーはこれらの連携を 1 つ以上作成できます。

Show child attributes

modules

object[]

この action で使用される action module とそのバージョンの一覧。

Show child attributes

name

string

デフォルト:my-action

action の名前。

runtime

string

デフォルト:node22

Node runtime。例: node22、デフォルトは node22

secrets

object[]

action または action のバージョンに含まれる secrets の一覧。

Show child attributes

status

enum<string>

デフォルト:built

このアクションのビルドステータス。

利用可能なオプション:

pending,

building,

packaged,

built,

retrying,

failed

supported_triggers

object[]

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

Minimum array length: 1

Show child attributes

updated_at

string<date-time>

デフォルト:2021-01-01T00:00:00.000Z

この action が更新された日時。