Création de hooks

Comment créer des hooks à l’aide de Dashboard et Management API. Les hooks peuvent également être importés et exportés à l’aide de l’outil de déploiement d’interface de ligne de commande (Command-Line Interface, CLI) Auth0.

La date de fin de vie (EOL) des Règles et des Appels sera le 18 novembre 2026. Ils ne sont plus disponibles pour les nouveaux locataires créés à partir du 16 octobre 2023. Les locataires actuels ayant des hooks actifs conserveront l’accès aux produit Hooks jusqu’à la fin de leur durée de vie.

Nous vous conseillons vivement d’utiliser les Actions pour étendre Auth0. Avec les Actions, vous avez accès à des informations de type enrichies, à une documentation intégrée et à des packages npm publics, et vous pouvez connecter des intégrations externes qui optimisent votre expérience d’extensibilité globale. Pour en savoir plus sur ce que les Actions proposent, consultez Comprendre comment fonctionnent Auth0 Actions.

Pour vous aider dans votre migration, nous proposons des guides qui vous aideront à migrer des Règles vers les Actions et à migrer des Hooks vers les Actions. Nous avons également une page dédiée à la Migration vers les Actions qui met en évidence les comparaisons de fonctionnalités, une démo des Actions et d’autres ressources pour vous aider dans votre parcours de migration.

Pour en savoir plus sur l’obsolescence des Règles et des Appels, consultez notre article de blog : Preparing for Rules and Hooks End of Life (Préparation à la fin de vie des règles et des crochets).

Comme nous prévoyons de supprimer les fonctions Règles et Hooks en 2026, vous devez créer de nouvelles Règles ou de nouveaux Hooks uniquement dans votre environnement de développement et uniquement pour tester la migration vers les Actions.

Pour apprendre à migrer vos Règles vers des Actions, consultez Migrer des règles vers les actions. Pour apprendre à migrer vos Hooks vers des Actions, consultez la section Migrer des Hooks vers les actions.

Vous pouvez créer plusieurs hooks à l’aide de Dashboard et Management API.

Vous pouvez également importer et exporter des hooks à l’aide de l’outil Deploy CLI.

Bien que vous puissiez créer plusieurs hooks pour un point d’extensibilité donné, chaque point d’extensibilité ne peut avoir qu’un seul hook activé à la fois. Tous les appels ultérieurs que vous créez pour ce point d’extensibilité sont automatiquement désactivés. Vous devez donc les activer explicitement. Le hook activé sera exécuté pour toutes les applications et API.

En option, vous pouvez ajouter des secrets (tels que des clés Twilio ou des chaînes de connexion à la base de données) aux hooks.

​

Utiliser Dashboard

1. Allez à Tableau de bord Auth0 > Pipeline Auth > Crochets, et cliquez sur +Créer.
2. Saisissez un nom descriptif pour votre hook, sélectionnez le point d’extensibilité pour lequel le hook doit s’exécuter, et cliquez sur Créer.
3. Localisez la section correspondant au point d’extensibilité que vous avez sélectionné et cliquez sur l’icône en forme de crayon à côté du hook que vous avez créé.
4. Mettez à jour le hook à l’aide du Éditeur de hooks et cliquez sur l’icône de disquette pour l’enregistrer.

​

Utiliser Management API

Effectuez un appel POST au point de terminaison Créer un point de terminaison de hook. Veillez à remplacer les paramètres fictifs MGMT_API_ACCESS_TOKEN, HOOK_NAME, HOOK_SCRIPT et EXTENSIBILITY_POINT_NAME par votre jeton d’accès à Management API, le nom de l’appel, le script du hook et le nom du point d’extensibilité, respectivement.

cURL

curl --request POST \
  --url 'https://{yourDomain}/api/v2/hooks' \
  --header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --data '{ "name": "HOOK_NAME", "script": "HOOK_SCRIPT", "triggerId": "EXTENSIBILITY_POINT_NAME" }'

Valeur	Description
MGMT_API_ACCESS_TOKEN	Jeton d’accès à Management API avec la permission create:hooks. Pour en savoir plus, lisez Jeton d’accès à Management API.
HOOK_NAME	Nom de l’appel à créer.
HOOK_SCRIPT	Script contenant le code de l’appel. Doit correspondre à ce que vous entreriez si vous créiez un nouvel appel en utilisant le Dashboard.
EXTENSIBILITY_POINT_NAME	Nom du point d’extensibilité pour lequel l’appel doit s’exécuter. Options à inclure : credentials-exchange, pre-user-registration, post-user-registration, post-change-password. Pour en savoir plus sur les points d’extensibilité, lisez Points d’extensibilité.

Gérer les limitations de taux lors d’une requête API depuis un Hook

Si vous faites une requête API Auth0 à partir d’un script de Hook, vous devrez gérer les limitations de taux. Pour ce faire, vérifiez l’en-tête X-RateLimit-Remaining et gérez la situation de manière adéquate lorsque le numéro retourné s’approche de 0.

De plus, ajoutez le code nécessaire pour gérer les cas dans lesquels vous dépassez les limites de taux et recevez un code de statut HTTP 429(Too Many Requests). Dans ce cas, si une nouvelle requête est nécessaire, il est recommandé de prévoir un délai d’attente pour éviter de se retrouver dans une boucle infinie de tentatives.

Pour en savoir plus sur la limite anti-attaques d’Auth0 pour les hooks, lisez Limites anti-attaques.

​

En savoir plus

• Migrer des Hooks vers les Actions