Obtenir les 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.ListAsync(
            new ListHooksRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Enabled = true,
                Fields = "fields",
                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.ListHooksRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Enabled: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        TriggerId: management.HookTriggerIdEnumCredentialsExchange.Ptr(),
    }
    mgmt.Hooks.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

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

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

        client.hooks().list(
            ListHooksRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .enabled(true)
                .fields("fields")
                .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\ListHooksRequestParameters;
use Auth0\SDK\API\Management\Types\HookTriggerIdEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->hooks->list(
    new ListHooksRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'enabled' => true,
        'fields' => 'fields',
        'triggerId' => HookTriggerIdEnum::CredentialsExchange->value,
    ]),
);

from auth0.management import ManagementClient

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

client.hooks.list(
    page=1,
    per_page=1,
    include_totals=True,
    enabled=True,
    fields="fields",
    trigger_id="credentials-exchange",
)

require "auth0"

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

client.hooks.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  enabled: true,
  fields: "fields",
  trigger_id: "credentials-exchange"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        triggerId: "credentials-exchange",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        triggerId: "credentials-exchange",
    });
}
main();

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

GET

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.ListAsync(
            new ListHooksRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Enabled = true,
                Fields = "fields",
                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.ListHooksRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Enabled: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        TriggerId: management.HookTriggerIdEnumCredentialsExchange.Ptr(),
    }
    mgmt.Hooks.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

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

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

        client.hooks().list(
            ListHooksRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .enabled(true)
                .fields("fields")
                .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\ListHooksRequestParameters;
use Auth0\SDK\API\Management\Types\HookTriggerIdEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->hooks->list(
    new ListHooksRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'enabled' => true,
        'fields' => 'fields',
        'triggerId' => HookTriggerIdEnum::CredentialsExchange->value,
    ]),
);

from auth0.management import ManagementClient

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

client.hooks.list(
    page=1,
    per_page=1,
    include_totals=True,
    enabled=True,
    fields="fields",
    trigger_id="credentials-exchange",
)

require "auth0"

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

client.hooks.list(
  page: 1,
  per_page: 1,
  include_totals: true,
  enabled: true,
  fields: "fields",
  trigger_id: "credentials-exchange"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        triggerId: "credentials-exchange",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.hooks.list({
        page: 1,
        perPage: 1,
        includeTotals: true,
        enabled: true,
        fields: "fields",
        triggerId: "credentials-exchange",
    });
}
main();

[
  {
    "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.

Paramètres de requête

page

integer

Index de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page

integer

Nombre de résultats par page.

Plage requise: 0 <= x <= 100

include_totals

boolean

Renvoie les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau direct de résultats (false, par défaut).

enabled

boolean

Filtre facultatif indiquant si un hook est activé (true) ou désactivé (false).

fields

string

Liste de champs à inclure dans le résultat, séparés par des virgules. Laissez vide pour récupérer tous les champs.

triggerId

enum<string>

Récupère les hooks qui correspondent au trigger Récupère les hooks correspondant au trigger

Options disponibles:

credentials-exchange,

pre-user-registration,

post-user-registration,

post-change-password,

send-phone-message

Réponse

Hooks récupérés avec succès.

object[]
object

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 lors de l’exécution de ce hook.

triggerId

string

ID du Trigger