イベントオブジェクト

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

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

Event Object

{
  "secrets": {},
  "message_options": {
    "action": "string",
    "code": "string",
    "message_type": "string",
    "recipient": "string",
    "text": "string"
  },
  "request": {
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object · optional

このトランザクションを開始したクライアントに関する情報。

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

client_id · string

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

metadata · dictionary

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

name · string

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

​

event.custom_domain

event.custom_domain · object · optional

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

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

domain · string

カスタムドメイン名。

domain_metadata · dictionary

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

​

event.message_options

event.message_options · object

ユーザーに送信するメッセージの詳細。

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

action · string

このActionをトリガーしたフロー。

許可される値: enrollment, second-factor-authentication

code · string

ユーザーがFormに入力するワンタイムパスワード。

message_type · string

メッセージの配信方法。sms または voice です。

許可される値: sms, voice

recipient · string

メッセージの送信先の電話番号。

text · 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.security_context

event.security_context · object · optional

フィンガープリントシグネチャを含むオブジェクト。クライアントがCloudflareを使用している場合にのみ利用できます。JA3/JA4フィンガープリントは、場合によってはnullまたは空になります。最も一般的なのはHTTPリクエストの場合です。これは、JA3とJA4がTLSで計算されるためです。Workerが同じゾーン内、プロキシされていないゾーン、またはサードパーティにリクエストを送信した場合にも空になることがあります。

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

ja3 · string · optional

JA3フィンガープリントシグネチャ。クライアントがTLS接続を使用している場合にのみ利用できます。

ja4 · string · optional

JA4フィンガープリントシグネチャ。クライアントがTLS接続を使用している場合にのみ利用できます。

​

event.tenant

event.tenant · object

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

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

id · string

テナントの名前。

​

event.transaction

event.transaction · object · optional

現在のトランザクションの詳細。

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

correlation_id · string · optional

アプリケーションが Universal Login にリダイレクトする際、初回認証リクエストで Correlation ID を指定できます。この値を使用して、Action コードからのログやリクエストをユーザーフローに関連付けることができます。

​

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

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