Récupérer les Hooks

Récupère tous les Hooks. Accepte une liste de champs à inclure ou à exclure du résultat.

GET https://{tenantDomain}/api/v2/hooks

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    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(),
    }
    client.Hooks.List(
        context.TODO(),
        request,
    )
}

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

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

Indice de page des 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 séparés par des virgules à inclure dans le résultat. Laissez vide pour récupérer tous les champs.

triggerId · enum<string>

Récupère les Hooks correspondant au déclencheur Récupère les hooks qui correspondent au déclencheur

Options disponibles: credentials-exchange, pre-user-registration, post-user-registration, post-change-password, send-phone-message

Réponse

200

application/json

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).

id · 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 déclencheur