イベントストリームを作成する

新しいユーザープロファイルの作成など、さまざまな種類のイベントをリッスンするイベントストリームを作成できます。イベントを購読し、イベントストリームを使って任意の送信先に配信することで、次のようなさまざまな用途に活用できます。

新規顧客に歓迎メールを送信したり、メールアドレスの確認を依頼したりする。
ユーザーライフサイクルの変化を監視して、CRM (顧客関係管理) や請求システムを更新する。

AWS EventBridge または webhook のいずれかを使用してイベントストリームを作成できます。以下の各セクションでは、それぞれの設定手順を説明します。

イベントストリームを有効にすると、Auth0 Platform からエクスポートされるデータの管理者となり、どの情報をストリーミングするか、その保護方法、使用方法について責任を負います。Auth0 環境とは異なる地理的リージョンにある送信先エンドポイントを設定すると、この設定によりリージョン間のデータ転送が開始されます。送信先の設定を管理し、結果として生じる越境データ転送が社内ポリシーおよび適用されるデータ保護法に準拠していることを確認する責任は、お客様にのみあります。

Management API でアクセスする (任意)

イベントストリームは、または Auth0 Management API を使用してプロビジョニングできます。を使用する場合は、イベントストリームを設定する前に、マシンツーマシン (M2M) アプリケーションを作成し、Management API のトークンで認証する必要があります。詳しくは、Management API Access Tokens を参照してください。

Dashboard > Applications > Applications に移動し、Create Application を選択します。
アプリケーション名をわかりやすく入力し、Machine to Machine Applications を選択します。次に、Create を選択します。
アプリケーションから呼び出す API を選択します。この場合は、Auth0 Management API を使用します。
アプリケーションのアクセストークンに含める権限を選択し、Authorize を選択します。テスト目的の場合は、次を選択します。
- read:event_streams
- create:event_streams
- update:event_streams
- delete:event_streams
- read:event_deliveries
- update:event_deliveries
- create:users
Settings タブに移動し、Client ID、Client Secret、Domain を確認します。
Get Management API Access Tokens を参照して、アクセストークンを取得し保存します。

AWS EventBridge

以下では、AWS EventBridge を使用してイベントストリームを作成し、有効化する方法について説明します。

EventBridge の前提条件

イベントストリームで AWS EventBridge を使用するには、次のものが必要です。

AWS アカウント
- AWS アカウントには、EventBridge を使用するための権限が必要です。アカウントをお持ちでない場合は、https://aws.amazon.com/eventbridge/ から登録してください。
AWS IAM 権限
AWS EventBridge イベントバス
AWS アカウント ID とリージョン

イベントストリームを作成 (EventBridge)

Management API
Auth0 Dashboard
Terraform

イベントストリームを使用すると、Auth0 テナント内のリアルタイムの変更を取得し、処理のために外部システムへ送信できます。イベントストリームを設定する前に、監視するイベントタイプを特定する必要があります。次に、以下に示すように、AWS アカウント ID とリージョンを使用してイベントストリームを設定します。この例では、Auth0 CLI を使用して、user.created イベントをサブスクライブするイベントストリームを作成します。このイベントは、テナントで新しいユーザーが登録されるたびにトリガーされます。

auth0 events create --name ng-demo-eventbridge --type eventbridge --subscriptions "user.created" --configuration '{"aws_account_id":"<your-aws-account-id>","aws_region":"<your-aws-region>"}'

成功すると、この呼び出しは event stream の id を含む以下の JSON を返します。新しい event streams はデフォルトで有効です。

{
  "id": "est_8of6RXoM1997qikH7NS11h",
  "status": "enabled",
  "name": "ng-demo-eventbridge",
  "subscriptions": [
    {
      "event_type": "user.created"
    }
  ],
  "created_at": "2025-01-29T18:08:43.440Z",
  "updated_at": "2025-01-29T18:08:43.440Z",
  "destination": {
    "type": "eventbridge",
    "configuration": {
      "aws_account_id": "<your-aws-account-id>",
      "aws_region": "<your-aws-region>",
      "aws_partner_event_source": "default"
    }
  }
}

AWS EventBridge を使用して Auth0 Dashboard でイベントストリームを作成するには、次の手順に従います。

Auth0 Dashboard > Event Streams (Early) に移動します。
+Create Event Stream を選択します。
ストリームタイプの一覧から AWS EventBridge を選択します。新しい EventBridge ストリームの設定フォームが開きます。
ストリームの詳細を設定: 設定フォームで、次の情報を入力します。
- ストリーム名: イベントストリームの内容がわかる名前を入力します。これにより、Auth0 Dashboard 内で識別しやすくなります。
- AWS アカウント ID: Auth0 イベントの送信先となる 12 桁の AWS アカウント ID を入力します。
- AWS リージョン: EventBridge イベントバスが配置されている AWS リージョンを選択します。
イベントタイプを選択: Select Event Types セクションで、このストリームに含める Auth0 のイベントタイプを選択します。要件に応じて複数のイベントタイプを選択できます (例: user.created、user.updated、user.deleted) 。
変更を保存: ストリーム名、AWS の詳細、および必要なイベントタイプの選択が完了したら、Save Changes ボタンをクリックします。

これで新しいイベントストリームが作成され、Auth0 は選択したイベントタイプを指定した AWS EventBridge イベントバスに配信できるようになります。イベントストリームのステータスの確認や管理は、Auth0 Dashboard の Event Streams (Early) ページから行えます。

Terraform を使い始める前に、次の準備が必要です。

Terraform CLI をインストールする
Auth0 CLI をインストールし、auth0 login で認証する
EventBridge ストリームの設定に必要な AWS アカウント ID と AWS リージョンを用意する

ファイル構成

Terraform を使用してイベントストリームをプロビジョニングするには、適切に構成されたプロジェクトディレクトリが必要です。初めて設定する場合の構成例を以下に示します。

auth0-event-streams/
├── main.tf             # コア設定: プロバイダーと 'auth0_event_stream' リソースを定義します。
├── variables.tf        # 変数宣言: 'aws_account_id' や 'aws_region' などの入力変数を定義します。
└── terraform.tfvars    # 変数の値: 実際の設定値（例: "123456789012"）を保持します。

変数を定義する

variables.tf ファイルで、ストリーム設定に必要な入力変数を宣言します。

variable "aws_account_id" {
  description = "The 12-digit AWS Account ID where the EventBridge event bus resides."
  type        = string
}

variable "aws_region" {
  description = "The AWS region (e.g., us-east-1) for the EventBridge event bus."
  type        = string
}

変数の値を設定する

terraform.tfvars ファイルに、ご利用の環境に合わせた実際の値を指定します。

aws_account_id = "<your-aws-account-id>" # 例: "123456789012"
aws_region     = "<your-aws-region>"     # 例: "us-east-1"

環境変数を設定する

ターミナルで、前述の「Access Management API (任意) 」でコピーした認証情報を使って、必要な 3 つの環境変数を設定します。

export AUTH0_DOMAIN="your-tenant-name.auth0.com"
export AUTH0_CLIENT_ID="your_m2m_client_id"
export AUTH0_CLIENT_SECRET="your_m2m_client_secret"

イベントストリームを作成する

この例では、auth0_event_stream リソースを使用して、user.created イベントを購読するイベントストリームを作成します。user.created イベントは、テナントに新しいユーザーが登録されるたびに発生します。以下のサンプルを main.tf ファイルで使用してください。

terraform {
  required_providers {
    auth0 = {
      source  = "auth0/auth0"
      version = ">= 1.0.0" 
    }
  }
}

provider "auth0" {}

resource "auth0_event_stream" "eventbridge_stream" {
  name             = "ng-demo-eventbridge-tf"
  destination_type = "eventbridge" # 必須
  subscriptions    = ["user.created"]

  eventbridge_configuration {
    aws_account_id = var.aws_account_id
    aws_region     = var.aws_region
  }
}

成功すると、このリクエストはイベントストリームの id を含む次の JSON を返します。新しいイベントストリームはデフォルトで有効になっています。上記 3 つのファイルをすべて作成して保存したら、イベントストリームを作成する準備は完了です。

プロバイダーを初期化する

terraform init

変更内容を確認します:

terraform plan

ストリームを作成します:

terraform apply

Webhooks

AWS EventBridge の代わりに、Webhook を使ってイベントストリームを利用できます。始めるには、まず特定のイベントが発生した際にリアルタイム通知を受け取れるよう、Webhook ハンドラーを設定します。次に、イベントストリームを作成します。以下の手順に沿って基本的な Webhook ハンドラーを作成することも、次のような既存のサービスを利用することもできます。

Vercel
Inngest

既存のサービスを利用する場合は、イベントストリームを作成する (Webhook) に進んでください。そうでない場合は、以下の手順に沿って独自の基本的な Webhook ハンドラーを作成してください。

Webhookの前提条件

Webhookハンドラーを正しく作成するには、以下がインストールされていることを確認してください。

node.js
jq
npm
ngrok

webhook ハンドラーを作成する

express を node_modules フォルダーにインストールし、package.json の依存関係にも追加します。
環境変数を保存する .env ファイルを使えるように、ルートディレクトリに dotenv をインストールします。

user.created イベントを受信してデータベースに保存する webhook.js ファイルを作成します。

const express = require('express');
const app = express();

// Authorization ミドルウェア
app.use((req, res, next) => {
  const token = req.headers["authorization"];
  if (token !== `Bearer ${API_TOKEN}`) {
    return res.status(401).json({ error: "Unauthorized" });
  }
  next();
});

// Webhook エンドポイント
app.post("/webhook", async (req, res) => {
  console.log("Webhook received:", JSON.stringify(req.body, null, 2));

  const eventData = req.body;
  const { id, type, time, data } = eventData;
  const user = data.object;

  try {
    switch (type) {
      case "user.created":
        await handleUserCreated(user, time);
        break;
      case "user.updated":
        await handleUserUpdated(user, time);
        break;
      case "user.deleted":
        await handleUserDeleted(user, time);
        break;
      default:
        await handleDefaultEvent(id, type, time, data);
    }

    console.log(`Webhook event of type '${type}' committed to the database.`);
    res.sendStatus(204);
  } catch (err) {
    console.error("Error processing webhook:", err);
    res.status(500).json({ error: "Internal server error" });
  }
});

// user.created イベントを処理する専用の関数
// この例では、ユーザーが自前のデータベースにも作成されるようにしています
async function handleUserCreated(user, time) {
  const { user_id, email, name, nickname, created_at, updated_at } = user;

  const query = `
    INSERT INTO users (user_id, email, name, nickname, created_at, updated_at, raw_user, last_event_processed)
    VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
  `;
  const values = [
    user_id,
    email,
    name,
    nickname,
    created_at,
    updated_at,
    user,
    time,
  ];

  try {
    await getPool().query(query, values);
  } catch (err) {
    if (err.code === "23505") {
      console.error(`Duplicate user_id=${user_id}, skipping insert.`);
    } else {
      console.error(`Database error while creating user_id=${user_id}:`, err);
      throw err;
    }
  }
}

プロジェクトのルートに .env ファイルを作成し、次のように API トークンを追加します。
API_TOKEN=`openssl rand -hex 32` echo "API_TOKEN=$API_TOKEN" > .env
サーバーを起動します。
node webhook.js
Webhook をテストするには、ngrok などのツールを使って webhook ハンドラーを公開します。
ngrok http 3000
これにより、ローカルの webhook ハンドラー用に公開 URL が提供されます。たとえば、次のようになります。
http://localhost:3000

イベントストリームを作成する (webhooks)

イベントストリームを使用すると、Auth0テナント内のリアルタイムな変更を取得し、処理のために外部システムに送信できます。イベントストリームを設定する前に、監視したいイベントタイプを特定する必要があります。次に、以下の例のように、Webhookハンドラーを使用してイベントストリームを作成します。

Management API
Auth0 Dashboard
Terraform

この例では、Auth0 CLI を使用して、テナントで新しいユーザーが登録されるたびに発生する user.created イベントをサブスクライブするイベントストリームを作成します。続いて、イベントデータは追加の処理のために Webhook エンドポイントへ転送されます。

source .env # .envファイルを作成したwebhookディレクトリにいることを確認してください
WEBHOOK_URL="<ngrok URL>/webhook"

auth0 events create -n my-event1 -t webhook -s "user.created" -c '{"webhook_endpoint":"'"${WEBHOOK_URL}"'","webhook_authorization":{"method":"bearer","token":'"${API_TOKEN}"'"}}'

成功すると、イベントストリームの id を含む以下の JSON が返されます。新しいイベントストリームはデフォルトで有効です。

{
  "id": "est_8of6RXoM1997qikH7NS11h",
  "status": "enabled",
  "name": "ng-demo-2",
  "subscriptions": [
    {
      "event_type": "user.created"
    }
  ],
  "created_at": "2025-01-29T18:08:43.440Z",
  "updated_at": "2025-01-29T18:08:43.440Z",
  "destination": {
    "type": "webhook",
    "configuration": {
      "webhook_endpoint": "https://example.com/webhook",
      "webhook_authorization": {
        "method": "bearer"
      }
    }
  }
}

イベントストリームを確認する

イベントストリームを作成したら、次のコマンドを使用して、イベントストリームが存在することを確認できます。

auth0 events show <EVENT_STREAM_ID>

AWS EventBridge を使用して Auth0 Dashboard でイベントストリームを作成するには、次の手順に従います。

Auth0 Dashboard > Event Streams (Early) に移動します。
+Create Event Stream を選択します。
ストリームタイプの一覧から Webhook を選択します。すると、新しい Webhook ストリームの設定フォームが開きます。
ストリームの詳細を設定: 設定フォームで、次の情報を入力します。
- ストリーム名: イベントストリームを識別しやすい名前を入力します。これにより、Auth0 Dashboard 内で見分けやすくなります。
- エンドポイント: Auth0 がイベントの送信先とする HTTP エンドポイントの完全な URL を入力します。ここで指定したサービスがイベントデータを受信して処理します。
- 認証方法: エンドポイントで必要な認証方法を選択します。
- Authorization Token: 認証方法として Bearer Token を選択した場合は、必要な認可トークンをここに入力します。
イベントタイプを選択: Select Event Types セクションで、このストリームに含める Auth0 のイベントタイプを選択します。要件に応じて複数のイベントタイプを選択できます (例: user.created、user.updated、user.deleted) 。
変更を保存: ストリーム名と AWS の詳細を設定し、必要なイベントタイプを選択したら、Save Changes ボタンをクリックします。

これで新しいイベントストリームが作成され、Auth0 は選択したイベントタイプを指定した Webhook へ配信できるようになります。ステータスの確認やイベントストリームの管理は、Auth0 Dashboard の Event Streams (Early) ページから行えます。

ファイル構成

Terraform を使用してイベントストリームをプロビジョニングするには、整理されたプロジェクトディレクトリ構成が必要です。初めて設定する際の構成例を以下に示します。

auth0-event-streams/
├── main.tf             # コア設定: プロバイダーと 'auth0_event_stream' リソースを定義します。
├── variables.tf        # 変数宣言: 'aws_account_id' や 'aws_region' などの入力変数を定義します。
└── terraform.tfvars    # 変数の値: 実際の設定値（例: "123456789012"）を保持します。

変数を定義する

variables.tf ファイルで、ストリーム設定に必要な入力変数を宣言します。

variable "api_token" {
  description = "The secret token used for Webhook Bearer Authorization."
  type        = string
  sensitive   = true 
}

variable "webhook_endpoint_url" {
  description = "The public HTTPS URL for the webhook handler (e.g., your ngrok URL)."
  type        = string
}

環境設定

上で生成した API トークンを使用して、TF_VAR_ プレフィックスを付けた環境変数をターミナルで安全に設定します。

export AUTH0_DOMAIN="your-tenant-name.auth0.com"
export AUTH0_CLIENT_ID="your_m2m_client_id"
export AUTH0_CLIENT_SECRET="your_m2m_client_secret"

成功すると、イベントストリームの id を含む以下の JSON が返されます。新しいイベントストリームはデフォルトで有効です。

export TF_VAR_api_token="${API_TOKEN}"

export AUTH0_DOMAIN="your-tenant-name.auth0.com"
export AUTH0_CLIENT_ID="your_m2m_client_id"
export AUTH0_CLIENT_SECRET="your_m2m_client_secret"

イベントストリームを作成する

この例では、auth0_event_stream リソースを使用して、user.created イベントをサブスクライブするイベントストリームを作成します。このイベントは、テナントで新しいユーザーが登録されるたびに発生します。次のサンプルを main.tf ファイルで使用してください。成功すると、この呼び出しはイベントストリームの id を含む次の JSON を返します。新しいイベントストリームはデフォルトで有効になっています。

terraform {
  required_providers {
    auth0 = {
      source  = "auth0/auth0"
      version = ">= 1.0.0" 
    }
  }
}

provider "auth0" {}

resource "auth0_event_stream" "webhook_stream" {
  name             = "my-webhook-handler-stream-tf"
  destination_type = "webhook" 
  subscriptions    = ["user.created"] 

  webhook_configuration {
    webhook_endpoint = var.webhook_endpoint_url

    webhook_authorization {
      method = "bearer"
      token  = var.api_token 
    }
  }
}

上記の3つのファイルをすべて作成して保存したら、イベントストリームを作成する準備は完了です。

プロバイダーを初期化する

terraform init

プランを実行します：

URL="<your-ngrok-url>/webhook"
terraform plan -var="webhook_endpoint_url=${URL}"

ストリームを作成します:

terraform apply -var="webhook_endpoint_url=https://<your-ngrok-url>/webhook"

ストリームがアクティブになったら、イベントストリームをテストできます。詳しくは、イベントのテスト、可観測性、障害からの復旧を参照してください。

Auth0 Actions

以下では、Auth0 Actions を使用してイベントストリームを作成し、有効化する方法を説明します。

イベントストリームを作成する (Actions)

Management API
Dashboard

イベントストリームを使用すると、Auth0 テナント内で発生するリアルタイムの変更を取得し、処理のために外部システムへ送信できます。イベントストリームを設定する前に、監視するイベントタイプを特定する必要があります。この例では、Auth0 CLI を使用して user.created イベントをサブスクライブするイベントストリームを作成します。このイベントは、テナントに新しいユーザーが登録されるたびにトリガーされます。

auth0 event-streams create \
  --name actions-1 \
  --type action \
  --subscriptions "user.created,user.updated,user.deleted" \
  --configuration '{"action_id":"385db79f-28a4-43d9-909d-6f5511dd6632"}'

成功すると、この呼び出しはイベントストリームの id を含む次の JSON を返します。新しいイベントストリームはデフォルトで有効になっています。

{
    "configuration": {
      "action_id": "act_xyz789...",
      "status": "enabled"
  }
}

Auth0 Actions を使用して Auth0 Dashboard でイベントストリームを作成するには、次の手順に従います。

Auth0 Dashboard > Event Streams (Early) に移動します。
+Create Event Stream を選択します。。
ストリームタイプの一覧から +Auth0 Actions を選択します。すると、新しい Auth0 Actions ストリームの設定フォームが開きます。
ストリームの詳細を設定: 設定フォームで、次の情報を入力します。
- ストリーム名: イベントストリームがわかりやすいように、説明的な名前を入力します。これにより、Auth0 Dashboard 内で識別しやすくなります。
イベントタイプを選択: Select Event Types セクションで、このストリームに含める Auth0 のイベントタイプを選択します。要件に応じて複数のイベントタイプを選択できます (例: Created、Updated、Deleted) 。
Action Editor でハンドラーコードを記述します。システムでは onExecuteEventStream 関数が必要です。api オブジェクトを使用して、成功または失敗の状態を管理できます。

/**
 * Event Stream の実行時に呼び出されるハンドラー。
 * @param {Event} event - Cloud Event の詳細。
 * @param {EventStreamAPI} api - イベントの処理に使用できるメソッドを持つインターフェース。
 */
exports.onExecuteEventStream = async (event, api) => {
  const eventType = event.message.type;
  const eventData = event.message.data;

  console.log(`Received event: ${eventType}`);

  // カスタムロジック: 例: 外部 API にデータを送信する
  // await axios.post('https://my-crm.com/ingest', eventData);

  // 障害処理:
  // 再試行をトリガーするには、エラーをスローするか api.message.fail() を使用します
  if (!eventData) {
     // api.message.fail('No data received');
     throw new Error('No data received');
  }

  // 成功:
  // 関数がエラーなく終了すると、イベントは配信済みとしてマークされます。
};

変更を保存: ストリーム名と Action ハンドラーを設定すると、システムによって Action が自動的に作成され、ストリームにバインドされて有効になります。

これで新しいイベントストリームが作成され、Auth0 は選択したイベントタイプを指定した Auth0 Action に公開し始めます。Auth0 Dashboard の Event Streams (Early) ページで、ステータスの確認やイベントストリームの管理を行えます。

ブランドのカスタマイズ

コードのカスタマイズ

サードパーティによるカスタマイズ

イベントストリームを作成する

Management API でアクセスする (任意)

AWS EventBridge

EventBridge の前提条件

イベントストリームを作成 (EventBridge)

ファイル構成

変数を定義する

変数の値を設定する

環境変数を設定する

イベントストリームを作成する

Webhooks

Webhookの前提条件

webhook ハンドラーを作成する

イベントストリームを作成する (webhooks)

イベントストリームを確認する

ファイル構成

変数を定義する

環境設定

イベントストリームを作成する

Auth0 Actions

イベントストリームを作成する (Actions)

詳しく見る

​Management API でアクセスする (任意)

​AWS EventBridge

​EventBridge の前提条件

​イベントストリームを作成 (EventBridge)

​ファイル構成

​変数を定義する

​変数の値を設定する

​環境変数を設定する

​イベントストリームを作成する

​Webhooks

​Webhookの前提条件

​webhook ハンドラーを作成する

​イベントストリームを作成する (webhooks)

​イベントストリームを確認する

​ファイル構成

​変数を定義する

​環境設定

​イベントストリームを作成する

​Auth0 Actions

​イベントストリームを作成する (Actions)

​詳しく見る

Management API でアクセスする (任意)

AWS EventBridge

EventBridge の前提条件

イベントストリームを作成 (EventBridge)

ファイル構成

変数を定義する

変数の値を設定する

環境変数を設定する

イベントストリームを作成する

Webhooks

Webhookの前提条件

webhook ハンドラーを作成する

イベントストリームを作成する (webhooks)

イベントストリームを確認する

ファイル構成

変数を定義する

環境設定

イベントストリームを作成する

Auth0 Actions

イベントストリームを作成する (Actions)

詳しく見る