イベントオブジェクト

トリガーの実行に関するコンテキスト情報を提供する、custom-phone-provider Action トリガーのイベントオブジェクトについて説明します。

custom-phone-provider Actions トリガーの event オブジェクトは、トリガーの実行に関するコンテキスト情報を提供します。

Event Object

{
  "secrets": {},
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "as_text": "string",
    "as_voice": "string",
    "delivery_method": "string",
    "message_type": "string",
    "recipient": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object

このログイントランザクションの開始に使用されたクライアントに関する情報。

非表示 event.client のプロパティ

client_id · string

ユーザーがログインするアプリケーションのクライアントID。

metadata · dictionary

その他のアプリケーションプロパティを保持するためのオブジェクト。

name · string

アプリケーションの名前 (Auth0 Dashboardで定義) 。

​

event.connection

event.connection · object · optional

ユーザーの認証に使用された接続の詳細。

非表示 event.connection のプロパティ

id · string

接続の一意の識別子。

metadata · dictionary · optional

接続に関連付けられたメタデータ。

name · string

ユーザーの認証に使用された接続の名前 (twitter や some-g-suite-domain など) 。

strategy · string

接続の種類。ソーシャル接続の場合、event.connection.strategy === event.connection.name となります。エンタープライズ接続の場合、strategy は waad (Windows Azure AD) 、ad (Active Directory/LDAP) 、auth0 (データベース接続) などです。

​

event.custom_domain

event.custom_domain · object · optional

現在のトランザクションに関連付けられているカスタムドメインの詳細。

非表示 event.custom_domain のプロパティ

domain · string

カスタムドメイン名。

domain_metadata · dictionary

キーと値のペアで構成されるカスタムドメインのメタデータ。

​

event.notification

event.notification · object

非表示 event.notification のプロパティ

as_text · string

レンダリングされた、テキストメッセージとして配信可能なテキストです。

as_voice · string

レンダリングされた、音声テキストメッセージとして配信可能なテキストです。

code · string · optional

一部のタイプ (例: otp_verify、otp_enroll) でこのメッセージ用に生成されるワンタイムパスワードです。指定されている場合は、エンドユーザーに確実に伝達することが重要です。

delivery_method · string

メッセージの配信方法です。text または voice を指定できます。

許可される値: text、voice

from · string · optional

送信者の E.164 準拠の電話番号です。

locale · string · optional

メッセージのレンダリングに使用した locale です。BCP-47 仕様で定義される en_US などが該当します。

message_type · string

送信されるメッセージのタイプです。otp_verify や blocked_account などがあります。

許可される値: otp_verify、otp_enroll、blocked_account、change_password、password_breach

recipient · string

受信者の E.164 準拠の電話番号です。

​

event.organization

event.organization · dictionary · optional

現在のトランザクションに関連付けられている組織の詳細。

非表示 event.organizationのプロパティ

id · string

組織ID。

display_name · string

組織の表示名。

metadata · dictionary

組織に関連付けられたメタデータ。

name · string

組織の名前。

​

event.request

event.request · object

トランザクションを開始したリクエストに関する詳細。

非表示 リクエストのプロパティ

geoip · dictionary

非表示 geoip プロパティ

cityName · string · optional

continentCode · string · optional

countryCode · string · optional

countryCode3 · string · optional

countryName · string · optional

latitude · number · optional

longitude · number · optional

subdivisionCode · string · optional

subdivisionName · string · optional

timeZone · string · optional

hostname · string · optional

認証フローで使用されるホスト名。

ip · string

リクエストの送信元 IP アドレス。

language · string · optional

ブラウザーから要求された言語。

method · string

リクエストで使用される HTTP メソッド。

user_agent · string · optional

トランザクションの開始時に受信した User-Agent ヘッダーの値。

​

event.secrets

event.secrets · secrets

この Action に安全に紐付けられたシークレット値。

​

event.tenant

event.tenant · object

非表示 event.tenant のプロパティ

id · string

tenant の名前。

friendly_name · string · optional

tenant の表示名。通常は、ID を人間が読みやすい形式にしたものです。

home_url · string · optional

設定で定義されている場合は、tenant のホーム URL。

logo_url · string · optional

設定で定義されている場合は、tenant のロゴ URL。

support_email · string · optional

設定で定義されている場合は、tenant のサポート窓口のメールアドレス。

support_url · string · optional

設定で定義されている場合は、tenant のサポート窓口の URL。

​

event.transaction

event.transaction · object · optional

トレーシング用の現在のトランザクションに関する詳細。

非表示 event.transaction プロパティ

correlation_id · string · optional

分散トレーシングのために、複数のサービスにまたがってこのリクエストを関連付ける一意の識別子。

​

event.user

event.user · dictionary

現在のトランザクションが開始されたユーザーに関するオブジェクト。

非表示 event.user のプロパティ

app_metadata · dictionary

サポートプラン、セキュリティロール、アクセス制御グループなど、ユーザーがアクセスできる内容に影響する情報を保存するカスタムフィールド。

created_at · string

ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。

email · string · optional

(一意の) ユーザーのメールアドレス。

email_verified · boolean

ユーザーがメールアドレスを確認済みかどうかを示します。

family_name · string · optional

ユーザーの姓。

given_name · string · optional

ユーザーの名。

last_password_reset · string · optional

ユーザーのパスワードが最後にリセットまたは変更された日時を示すタイムスタンプ。ユーザーの作成時には、このフィールドは存在しません。このプロパティはデータベース接続でのみ使用できます。

name · string · optional

ユーザーのフルネーム。

nickname · string · optional

ユーザーのニックネーム。

phone_number · string · optional

ユーザーの電話番号。

phone_verified · boolean · optional

ユーザーが電話番号を確認済みかどうかを示します。

picture · string · optional

ユーザーのプロフィール画像を指すURL。

updated_at · string

ユーザーのプロファイルが最後に更新または変更された日時を示すタイムスタンプ。

user_id · string

(一意の) ユーザーの一意の識別子。

user_metadata · dictionary

勤務先住所、自宅住所、ユーザー設定など、ユーザーがアクセスできる内容に影響しない情報を保存するカスタムフィールド。

username · string · optional

(一意の) ユーザー名。

identities · array of objects · optional

ユーザーが最初に認証したアイデンティティプロバイダーから取得した情報を含みます。ユーザーは、プロファイルを複数のアイデンティティプロバイダーにリンクすることもできます。その場合、それらのアイデンティティもこの配列に含まれます。各アイデンティティプロバイダーオブジェクトの内容は、プロバイダーによって異なります。