Hook を投稿 - 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.Hooks.CreateAsync(
            new CreateHookRequestContent {
                Name = "name",
                Script = "script",
                TriggerId = HookTriggerIdEnum.CredentialsExchange
            }
        );
    }

}

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.CreateHookRequestContent{
        Name: "name",
        Script: "script",
        TriggerId: management.HookTriggerIdEnumCredentialsExchange,
    }
    mgmt.Hooks.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateHookRequestContent;
import com.auth0.client.mgmt.types.HookTriggerIdEnum;

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

        client.hooks().create(
            CreateHookRequestContent
                .builder()
                .name("name")
                .script("script")
                .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Hooks\Requests\CreateHookRequestContent;
use Auth0\SDK\API\Management\Types\HookTriggerIdEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->hooks->create(
    new CreateHookRequestContent([
        'name' => 'name',
        'script' => 'script',
        'triggerId' => HookTriggerIdEnum::CredentialsExchange->value,
    ]),
);

from auth0.management import ManagementClient

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

client.hooks.create(
    name="name",
    script="script",
    trigger_id="credentials-exchange",
)

require "auth0"

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

client.hooks.create(
  name: "name",
  script: "script",
  trigger_id: "credentials-exchange"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "dependencies": {},
  "enabled": false
}
'

{
  "dependencies": {},
  "enabled": true,
  "id": "00001",
  "name": "hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "triggerId": "<string>"
}

POST

https://{tenantDomain}/api/v2

hooks

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.Hooks.CreateAsync(
            new CreateHookRequestContent {
                Name = "name",
                Script = "script",
                TriggerId = HookTriggerIdEnum.CredentialsExchange
            }
        );
    }

}

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.CreateHookRequestContent{
        Name: "name",
        Script: "script",
        TriggerId: management.HookTriggerIdEnumCredentialsExchange,
    }
    mgmt.Hooks.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateHookRequestContent;
import com.auth0.client.mgmt.types.HookTriggerIdEnum;

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

        client.hooks().create(
            CreateHookRequestContent
                .builder()
                .name("name")
                .script("script")
                .triggerId(HookTriggerIdEnum.CREDENTIALS_EXCHANGE)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Hooks\Requests\CreateHookRequestContent;
use Auth0\SDK\API\Management\Types\HookTriggerIdEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->hooks->create(
    new CreateHookRequestContent([
        'name' => 'name',
        'script' => 'script',
        'triggerId' => HookTriggerIdEnum::CredentialsExchange->value,
    ]),
);

from auth0.management import ManagementClient

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

client.hooks.create(
    name="name",
    script="script",
    trigger_id="credentials-exchange",
)

require "auth0"

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

client.hooks.create(
  name: "name",
  script: "script",
  trigger_id: "credentials-exchange"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.create({
        name: "name",
        script: "script",
        triggerId: "credentials-exchange",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "dependencies": {},
  "enabled": false
}
'

{
  "dependencies": {},
  "enabled": true,
  "id": "00001",
  "name": "hook",
  "script": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };",
  "triggerId": "<string>"
}

承認

Authorization

string

header

必須

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

ボディ

name

string

デフォルト:my-hook

必須

このフックの名前。

Pattern: ^[a-zA-Z0-9]([ \-a-zA-Z0-9]*[a-zA-Z0-9])?$

script

string

デフォルト:module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

必須

このフックの実行時に実行されるコード。

Minimum string length: 1

triggerId

enum<string>

必須

このルールの実行ステージ。credentials-exchange、pre-user-registration、post-user-registration、post-change-password、または send-phone-message を指定できます。

利用可能なオプション:

credentials-exchange,

pre-user-registration,

post-user-registration,

post-change-password,

send-phone-message

dependencies

object

webtask server が使用する、このフックの依存関係。

Show child attributes

enabled

boolean

デフォルト:false

このフックを実行するか (true)、無視するか (false)。

レスポンス

Hook を正常に作成しました。

dependencies

object

webtask server が使用する、このフックの依存関係。

Show child attributes

enabled

boolean

デフォルト:true

このフックを実行するか (true)、無視するか (false)。

string

デフォルト:00001

このフックの ID。

name

string

デフォルト:hook

このフックの名前。

script

string

デフォルト:module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

このフックの実行時に実行されるコード。

triggerId

string

トリガー ID