初めてのActionを作成する

このガイドでは、Auth0 Dashboardで初めてアクションを作成して導入する方法を手順を追って説明します。基本的な機能性を理解してすべてのアクションで活用し、プログラミングモデルにも慣れて使いこなせるようになりましょう。ここで身につける知識は、目的やフローにかかわらず、どのアクションの作成でも基礎となるものです。

ユーザーがログインしたときにSlackチャンネルにメッセージを送信するアクションを作成してみましょう。このチュートリアルではPost Loginトリガーを使用しますが、ここで提供する情報はどの種類のトリガーでも役に立ちます。

このタスクを遂行するには、以下の作業が必要です。

• アクションを作成する

• シークレットを追加する

• 依存性を追加する

• 下書きを保存する

• カスタムロジックを追加する

• アクションをテストする

• アクションをデプロイする

• アクションをフローにアタッチする

• アクションの結果をテナントログで確認する

このアクションによってメッセージがSlackチャンネルに送信されるため、Slack WorkspaceのIncoming Webhookを作成する必要があります。Slack Webhook URLを作成してから、このガイドの手順に戻ってください。

特定のフローでアクションを機能させるには、アクションを作成してフローに追加する必要があります。

1. ［Auth0 Dashboard］>［Actions（アクション）］>［Library（ライブラリ）］の順に進み、［Create Action（アクションの作成）］>［Build from scratch（一から作成する）］を選択します。

2. 名前を入力し、ログインフローにアクションを追加するためにLogin / Post Loginトリガーを選択し、［Create（作成）］を入力します。

Actionsコードエディターが表示されます。

Actionsテンプレートギャラリーには、アクションの作成に役立つ多種多様なスターターテンプレートを取り揃えています。テンプレートからアクションを作成するには、以下の手順で行います。

1. ［Auth0 Dashboard］>［Actions（アクション）］>［Library（ライブラリ）］の順に進み、［Create Action（アクションの作成）］を選択します。

2. ［Choose from template（テンプレートから選択）］を選択します。

3. アクションを作成するのに使用したいテンプレートを選びます。

4. テンプレートにあるコードが読み取り専用のプレビューで表示されます。続行するには、［Use this template（このテンプレートを使用）］を選択します。

5. 名前を入力してから、［Create（作成）］を選択します。

アクションにはそれぞれシークレット値を含めることができ、アクセストークンやAPIキーなどの機密情報を保管するのに適しています。Slack Webhook URLをシークレットとして書き込んでみましょう。

1. Code Editorの左サイドバーにある鍵アイコンを選択します。

2. ［Add Secret（シークレットの追加）］を選択します。

3. シークレットの名前に「SLACK_WEBHOOK_URL」を指定します。

4. Slackが提供するWebhook URLを貼り付けて、［Create（作成）］を選択します。

シークレットがアクションに追加されました。新しいシークレットは、インテリジェントなコード補完機能に「event.secrets」と入力して使用することができます。

@slack/webhooknpmパッケージを使用すると、メッセージをSlackに簡単に送信できます。ネイティブなアドオンを使用せずにインストールできるのであれば、アクション内のnpmパッケージのほぼどれでも使用することができます。

依存関係を追加するには、以下を行います。

1. サイドバーにある依存関係アイコン（立方体のアイコン）を選択します。

2. ［Name（名前）］に「@slack/webhook」と入力します。

   デフォルトで、アクションは、依存関係が追加された時点で最新版の依存関係を使用します。

3. ［Create（作成）］を選択すると、依存関係がアクションに追加されます。

   

［Save Draft（下書きの保存）］を選択します。アクションは保存されますが、フローの一環としてはまだ実行されません。Actionsを使用すると、Auth0テナントでトラフィックに影響を与えることなく、アクションを作成し、編集してテストすることができます。アクションの動作が思い通りになったら、アクションをデプロイして、後でフローに追加します。

アクションにシークレットと依存関係を構成し終わったので、次はコードを書いてみましょう！

それぞれのアクションにはイベントオブジェクトがあり、アクションのトリガーに関する読み取り専用のコンテキスト情報が含まれています。エディターに「event.」と入力し始めると、イベントのプロパティとして使用可能なものがすべて表示されます。それぞれのトリガーに使用可能な情報については、「フローをトリガーを調べる」をお読みください。

アクションを使って早速Slackに通知してみましょう！アクションに以下のコードを追加します。

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

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

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

［Save Draft（下書きの保存）］を選択し、アクションを保存します。

実際のトラフィックを使ってテナントでアクションを実行する前にテストして、期待通りに動作することを確認します。

1. サイドバーにあるテストアイコン（三角形のアイコン）を選択します。ペイロードセクションには、アクションの作成時に選んだトリガーについて、編集可能なJSONデータが表示されます。

   

2. ［Run（実行）］ボタンを選択すると、Slackチャンネルにメッセージが表示されるはずです。

アクションが期待通りに動作していることが確認できたら、いよいよデプロイです。

［Deploy（導入）］を選択します。アクションをデプロイすると、その時点でのアクションのスナップショットが作成され、［Action Version（アクションのバージョン）］として記録されます。

［Version History（バージョン履歴）］を選択すると、アクションが「Version 1」として記録されているのが分かります。

これで、「Version 1」のアクションに影響を与えることなく、アクションを自由に更新して保存することができます。Auth0は現在デプロイされているバージョンのアクションを実行するため、アクションがもう一度デプロイされるまでは「Version 1」のアクションが実行されます。

新しいアクションを構成する最後の手順は、フローにアタッチすることです。これを行うと、アクションがテナントのトラフィックの一部として実行されるようになります。

1. ［Auth0 Dashboard］>［Actions］>［Flows（フロー）］の順に進むと、使用できるフローの一覧が表示されます。

2. ［Login flow（ログインフロー）］を選択し、my-slack-actionをフローにドラッグします。

   

3. ［Apply（適用）］を選択します。

これで、アクションがテナント内の実際のユーザートラフィックで実行されるようになりました。テスト環境をより強固にしたい場合には、複数のAuth0環境をセットアップすることを検討してください。

アクションがログインフローの一環として実行されるようになると、Auth0はアクションの各実行について情報をキャプチャしてテナントログに記録します。これを表示するには、［Auth0 Dashboard］>［Auth0 Dashboard（モニタリング）］>［Logs（ログ）］の順に進み、［Successful Login（正常なログイン）］イベントを選択します。

［Action Details（アクションの詳細）］ビューに、フローで実行されたアクションについての情報が表示されます。

これで、初めてのアクションを作成できました。次に、「フローとトリガーを調べる」を確認しながら、アクションを使って一般的なタスクを実行する方法を学習しましょう。