Rédigez votre première Action

Découvrez comment rédiger une Action : choisir un flow, créer une Action, la configurer et la lier au flow.

Ce guide vous montrera comment créer et déployer votre première Action à l’aide du Auth0 Dashboard. À la fin, vous devriez comprendre les fonctions de base que vous utiliserez avec toutes les Actions et être à l’aise avec le modèle de programmation. Ce que vous apprendrez constitue la base de la rédaction de toute Action, quel qu’en soit l’objectif ou le flow utilisé.

​

L’objectif : envoyer une notification à Slack lors de la connexion d’un utilisateur

Vous créez une Action qui envoie un message dans un canal Slack lorsqu’un utilisateur se connecte. Bien que ce tutoriel utilise le déclencheur Post Login, les renseignements fournis ici sont utiles pour des déclencheurs de tout type.

Pour accomplir cette tâche, vous ferez ce qui suit :

• Créer une Action
• Ajouter un Secret
• Ajouter une dépendance
• Enregistrer le brouillon
• Ajouter une logique personnalisée
• Tester une Action
• Déployer une Action
• Associer une Action à un Flow
• Voir les résultats d’une Action dans le journal du tenant

​

Prérequis

Comme cette Action enverra des messages sur un canal Slack, vous devez créer un Incoming Webhook pour un espace de travail Slack. Une fois l’URL du webhook Slack obtenue, vous pouvez poursuivre ce guide.

​

Créer une Action

Pour qu’une Action fonctionne dans un flow précis, vous devez d’abord créer l’Action, puis l’ajouter à un flow.

1. Accédez à Auth0 Dashboard > Actions > bibliothèque,, puis sélectionnez créer une Action > Build from scratch.
2. Saisissez un Name et sélectionnez le déclencheur Login / Post Login, puisque vous ajouterez une Action au Login flow, puis sélectionnez Create.

L’éditeur de code Actions s’affiche :

​

Créer une Action à partir d’un modèle

La galerie de modèles pour Actions propose plusieurs modèles de départ pour vous aider à créer une Action. Pour créer une Action à partir d’un modèle :

1. Accédez à Auth0 Dashboard > Actions > Bibliothèque, puis sélectionnez Créer une Action.
2. Sélectionnez Choisir à partir d’un modèle.
3. Sélectionnez le modèle que vous souhaitez utiliser pour créer une Action.
4. Vous devriez maintenant voir un aperçu en lecture seule du code du modèle. Pour continuer, sélectionnez Utiliser ce modèle.
5. Entrez un nom, puis sélectionnez Créer.

​

Ajouter un Secret

Chaque Action peut contenir des Secrets, qui conviennent au stockage de renseignements sensibles, comme les Jetons d’accès et les clés API. Stockons l’URL du webhook Slack dans un Secret.

1. Sélectionnez l’icône en forme de clé dans la barre latérale gauche de l’éditeur de code
2. Sélectionnez Add Secret.
3. Donnez au Secret le nom suivant : SLACK_WEBHOOK_URL.
4. Collez l’URL du webhook fournie par Slack et sélectionnez Create.

Vous verrez que le Secret a été ajouté à l’Action et vous pourrez utiliser ce nouveau Secret grâce à l’autocomplétion intelligente en tapant event.secrets.

Une fois un Secret créé, sa valeur ne sera jamais affichée. Auth0 chiffre tous les Secrets et les stocke en toute sécurité.

​

Ajouter une dépendance

Vous utiliserez le @slack/webhook package npm pour faciliter l’envoi d’un message à Slack. Vous pouvez utiliser presque n’importe quel package npm public dans une Action, à condition qu’il puisse être installé sans dépendre de modules complémentaires natifs.

Pour ajouter la dépendance :

1. Sélectionnez l’icône Dependency (icône en forme de cube) dans la barre latérale.

2. Pour Name, entrez @slack/webhook.

   Par défaut, votre Action utilisera la version la plus récente de la dépendance au moment de son ajout.

3. Sélectionnez Create et la dépendance devrait être ajoutée à l’Action :

   

Lorsque vous enregistrerez cette Action, la version la plus récente de votre dépendance sera résolue et remplacée par un numéro de version précis afin d’éviter que de futures mises à jour du package ne compromettent votre Action.

​

Enregistrer le brouillon

Sélectionnez Enregistrer le brouillon. Votre Action est enregistrée, mais elle ne sera pas encore exécutée dans les flux utilisateur. Avec Actions, vous pouvez créer, modifier et tester des Actions avant qu’elles n’aient une incidence sur le trafic de votre tenant Auth0. Une fois que le comportement de l’Action vous convient, vous déploierez l’Action et l’ajouterez à un Flow par la suite.

​

Ajouter de la logique personnalisée

Maintenant que l’Action a été configurée avec un Secret et une dépendance, passons au code!

Chaque Action comporte un objet d’événement contenant des renseignements contextuels en lecture seule pertinents pour le déclencheur associé. Si vous commencez à taper event. dans l’éditeur, toutes les propriétés disponibles de l’événement devraient s’afficher. Pour en savoir plus sur les renseignements offerts pour chaque déclencheur, consultez Explorer les Flows et les déclencheurs.

Utilisons notre Action pour envoyer une notification à Slack. Ajoutez ce code à votre action :

const { IncomingWebhook } = require('@slack/webhook');

exports.onExecutePostLogin = async (event, api) => {
    const url = event.secrets.SLACK_WEBHOOK_URL;
    const webhook = new IncomingWebhook(url);

    // Envoyer la notification
    await webhook.send({ text: "Logging In..." });
};

Sélectionnez Enregistrer le brouillon pour enregistrer votre Action.

​

Testez l’Action

Avant d’exécuter cette Action dans votre tenant avec du trafic réel, testez-la pour vous assurer qu’elle fonctionne comme prévu.

1. Sélectionnez l’icône Test (triangle) dans la barre latérale. Dans la section Payload, vous verrez des données JSON modifiables associées au déclencheur que vous avez sélectionné lors de la création de l’Action.

   

2. Sélectionnez le bouton Run et vous devriez voir un message apparaître dans votre canal Slack.

​

Déployer l’Action

Maintenant que nous avons confirmé que l’Action fonctionne comme prévu, il est temps de la déployer.

Sélectionnez Deploy. Le déploiement d’une Action prend un instantané de l’Action à ce moment précis et l’enregistre comme une version d’Action.

Sélectionnez Version History; vous devriez y voir l’Action enregistrée comme version 1 :

Vous pouvez maintenant mettre à jour votre Action et l’enregistrer sans modifier la version 1 de votre Action. Auth0 n’exécute que la version actuellement déployée d’une Action. Ainsi, tant que vous ne déployez pas de nouveau l’action, c’est la version 1 qu’Auth0 exécutera.

​

Associer l’Action à un Flow

La dernière étape pour configurer une nouvelle Action afin qu’elle soit exécutée dans le trafic de votre tenant consiste à l’associer à un Flow.

1. Accédez à Auth0 Dashboard > Actions > Flows pour afficher la liste des Flows disponibles :

2. Sélectionnez le Login flow et faites glisser my-slack-action dans le flow.

   

3. Sélectionnez Apply.

L’Action s’exécute maintenant sur du trafic utilisateur réel dans votre tenant. Si vous souhaitez un environnement de test plus robuste, envisagez de configurer plusieurs environnements Auth0.

​

Consulter les Actions dans les journaux du tenant

Maintenant que votre Action s’exécute dans le cadre du Login flow, Auth0 consigne des renseignements sur chaque exécution d’Action dans les journaux du tenant. Pour les consulter, accédez à Auth0 Dashboard > Monitoring > Logs, puis sélectionnez un événement connexion réussie.

Vous devriez voir une vue Détails de l’Action qui contient des renseignements sur toutes les Actions exécutées dans le cadre de ce flow.

​

Prochaines étapes

Maintenant que vous avez créé votre première Action, consultez Découvrir les Flows et les Déclencheurs pour voir comment effectuer certaines tâches courantes avec Actions.