Créer des Hooks - 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>"
}

Autorisations

Authorization

string

header

requis

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

Corps

name

string

défaut:my-hook

requis

Nom de ce hook.

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

script

string

défaut:module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

requis

Code à exécuter lorsque ce hook s’active.

Minimum string length: 1

triggerId

enum<string>

requis

Étape d’exécution de cette règle. Peut être credentials-exchange, pre-user-registration, post-user-registration, post-change-password ou send-phone-message.

Options disponibles:

credentials-exchange,

pre-user-registration,

post-user-registration,

post-change-password,

send-phone-message

dependencies

object

Dépendances de ce hook utilisées par le serveur Webtask.

Show child attributes

enabled

boolean

défaut:false

Indique si ce hook sera exécuté (true) ou ignoré (false).

Réponse

Hook créé avec succès.

dependencies

object

Dépendances de ce hook utilisées par le serveur Webtask.

Show child attributes

enabled

boolean

défaut:true

Indique si ce hook sera exécuté (true) ou ignoré (false).

string

défaut:00001

ID de ce hook.

name

string

défaut:hook

Nom de ce hook.

script

string

défaut:module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };

Code à exécuter lorsque ce hook s’active.

triggerId

string

ID du déclencheur