Créez votre premier Action Module

Créez votre premier Action Module Auth0 dans le Dashboard Auth0 en créant le module, en ajoutant des secrets et des dépendances NPM, en publiant une version et en l’utilisant pour envoyer des logs à un service externe.

​

Pour commencer

Suivez le Quickstart pour créer un Action Module et l’utiliser dans une Action afin d’envoyer des logs à un service externe.

1. Créer un module d’action

   Pour utiliser un Action Module dans une Action précise, vous devez d’abord créer l’Action Module, puis l’ajouter ou l’utiliser dans l’Action.

   Dashboard

   1. Accédez à Auth0 Dashboard > Actions > Library, puis sélectionnez Modules.
   2. Sélectionnez Create Module.
   3. Entrez un Name.
   4. Sélectionnez Create.

   Auth0 affiche l’éditeur de code.

   
2. Ajouter un secret

   Chaque module d’action peut contenir des paires clé-valeur secrètes. Utilisez-les pour stocker des renseignements sensibles, comme des clés API, des certificats et des valeurs qui peuvent varier d’un environnement à l’autre.

   Dashboard

   Enregistrez l’URL du service externe comme Secret.

   1. Sélectionnez l’icône dans la barre latérale gauche de l’éditeur de code.
   2. Sélectionnez Add Secret.
   3. Saisissez SERVICE_URL dans le champ Name.
   4. Saisissez l’URL du service externe dans le champ Value.
   5. Sélectionnez Create.

   

   Auth0 ajoute le Secret à la liste des Secrets du module d’action.

   Étape supplémentaire : Répétez les étapes pour enregistrer un API_KEY comme Secret que vous enverrez dans les en-têtes au service externe avec chaque requête.

   Une fois un Secret créé, Auth0 n’en révèle jamais la valeur. Auth0 chiffre tous les Secrets et les stocke de façon sécurisée.

   Chaque Secret de module d’action est indépendant des autres Modules d’action et des Secrets des Actions.

   Utilisez les Secrets dans le module d’action en saisissant actions.secrets.[secret_key].

3. Ajouter de la logique personnalisée

   Maintenant, ajoutez le code suivant à votre module d’action.

   Dashboard

   Ajoutez le code suivant à votre module d’action :

   module.exports = {
     sendLog: async (code, message) => {
       try {
         await fetch(actions.secrets.SERVICE_URL, {
           method: 'POST',
           headers: {
             'X-API-Key': actions.secrets.API_KEY,
           },
           body: JSON.stringify({
             code,
             message
           }),
         });
   
         console.log({
           code,
           message
         });
       } catch (err) {
         throw new Error('External service failure');
       }
   
       return;
     }
   };
   

   À noter :

   • Directives de codage
   • Limites
4. Enregistrer le brouillon

   Vous pouvez enregistrer un brouillon de votre Action Module.

   Dashboard

   1. Sélectionnez Save Draft.

   

   Cette opération enregistre votre Action Module sans publier de nouvelle version; elle n’aura donc aucun effet sur les Actions qui l’utilisent.

5. Publier le module Action

   Une fois que vous êtes satisfait du code de l’Action Module, il est temps de le publier.

   Dashboard

   1. Sélectionnez Publier.

   La publication d’un Action Module en crée un instantané à ce moment précis et l’enregistre comme une version d’Action Module.

   2. Sélectionnez Afficher l’historique des versions.

   

   Auth0 affiche la liste des versions d’Action Module, y compris le brouillon.

   Vous pouvez maintenant utiliser l’Action Module dans une Action.

   Chaque Action doit faire explicitement référence à la version d’Action Module, ce qui empêche les mises à niveau automatiques susceptibles d’introduire des erreurs inattendues.

6. Ajouter l’Action Module à une Action

   Ajoutons l’Action Module dans une Action.

   Dashboard

   1. Accédez à Auth0 Dashboard > Actions > Library, puis sélectionnez une Action spécifique.
   2. Dans l’éditeur d’Action, sélectionnez l’icône dans la barre latérale gauche.
   3. Sélectionnez Ajouter un module.
   4. Sélectionnez un Nom et une Version de module.
   5. Sélectionnez Ajouter.

   
7. Utilisez le module d’action dans l’Action

   Maintenant, utilisons l’Action Module dans l’Action.

   Dashboard

   1. Ajoutez l’instruction require.

   const logger = require('actions:logger');
   

   L’instruction require fait référence à l’Action Module au format actions:[module-name].

   2. Ajoutez l’appel à logger.sendLog dans la fonction Action, à l’endroit où vous souhaitez envoyer des logs.

   await logger.sendLog('logger_success', 'Your Action was able to use the Logger Action Module');
   

   3. Sélectionnez Deploy pour déployer l’Action.

   

   N’oubliez pas d’associer l’Action à un Trigger.

Vérification

Vous devriez maintenant avoir un Action Module entièrement fonctionnel utilisé par une Action.

---

​

Utilisation avancée

Dépendances NPM

Chaque Action Module peut ajouter et utiliser des dépendances NPM.

Dashboard

1. Sélectionnez l’icône dans la barre latérale gauche de l’éditeur de code.
2. Sélectionnez Add Dependency.
3. Saisissez le Name du package NPM.
4. Saisissez la Version du package NPM.
5. Sélectionnez Create.

Auth0 ajoute la dépendance à la liste des dépendances du Action Module.

Utilisez les dépendances répertoriées dans le Action Module en les important avec require('[package-name]').

Lorsque vous enregistrez cette Action, Auth0 résout la version la plus récente de votre dépendance et la remplace par un numéro de version précis afin d’éviter que de futures mises à jour du package ne brisent votre Action.

Vous pouvez fournir une version précise au lieu de latest.