アクションのトリガー:custom-phone-providerのイベントオブジェクト
電話メッセージプロバイダーは、現在早期アクセス版として提供されています。Auth0のリリースについては、「製品のリリース段階」を参照してください。
custom-phone-provider
アクショントリガーのevent
オブジェクトは、カスタム電話メッセージの送信と受信の要求に関するコンテキスト情報を提供します。
プロパティ |
説明 |
event.client
|
このログイントランザクションが開始されたクライアントに関する情報です。
以下のプロパティを含みます。
-
client_id :文字列。ユーザーがログインしているアプリケーションのクライアントIDです。
-
metadata :辞書。他のアプリケーションプロパティを含むオブジェクトです。
-
name :文字列。アプリケーションの名前(Dashboardで定義)です。
|
event.connection
(任意)
|
ユーザーの認証に使用された接続についての詳細です。
以下のプロパティを含みます。
-
id :任意の文字列。接続の一意の識別子です。
-
metadata :任意の辞書。接続に関連付けられているメタデータです。
-
name :任意の文字列。ユーザーの認証に使用される接続名(twitter やsome-g-suite-domain など)です。
-
strategy :任意の文字列。接続の種類です。ソーシャル接続の場合はevent.connection.strategy === event.connection.name です。エンタープライズ接続の場合、ストラテジーはwaad (Windows Azure AD)、ad (Active
Directory/LDAP)、auth0 (データベース接続)などになります。
|
event.notification
|
以下のプロパティを含みます。
|
event.organization
(任意)
|
現在のトランザクションに関連付けられている組織の詳細です。
以下のプロパティを含みます。
-
display_name :文字列。組織のフレンドリー名です。
-
id :文字列。組織の識別子です。
-
metadata :辞書。組織に関連付けられているメタデータです。
-
name :文字列。組織の名前です。
|
event.request
(任意)
|
トランザクションを開始した要求についての詳細です。
以下のプロパティを含みます。
-
geoip :任意のオブジェクトです。
以下のプロパティを含みます。
countryCode :任意の文字列
countryCode3 :任意の文字列
cityName :任意の文字列
latitude :任意の文字列
longitude :任意の文字列
timeZone :任意の文字列
subdivisionCode :任意の文字列
subdivisionName :任意の文字列
continentCode :任意の文字列
continentCode :任意の文字列
-
ip :任意の文字列。要求の送信元のIPアドレスです。
-
hostname :任意の文字列。認証フローに使用されているホスト名です。
-
method :任意の文字列。要求に使用されたHTTPメソッドです。
-
language :任意の文字列。ブラウザーから要求された言語です。
-
user_agent :任意の文字列。トランザクションの開始で受信したUser-Agent ヘッダーの値です。
|
event.tenant
|
以下のプロパティを含みます。
-
friendly_name :任意の文字列。テナントのフレンドリー名です。通常は人間に読めるバージョンのIDです。
-
home_url :任意の文字列。定義されている場合、設定にあるテナントのホームURLです
-
id :文字列。テナントの名前です。
-
logo_url :任意の文字列。定義されている場合、設定にあるテナントのロゴURLです。
-
support_email :任意の文字列。定義されている場合、設定にあるテナントのサポートサービスのメールアドレスです。
-
support_url :任意の文字列。定義されている場合、設定にあるテナントのサポートサービスのURLです。
|
event.user
|
代理で現在のトランザクションが開始されたユーザーを記述するオブジェクトです。
以下のプロパティを含みます。
-
app_metadata :辞書。サポートプラン、セキュリティロール、アクセス制御グループなどのユーザーアクセスに影響するユーザー情報を保管するカスタムフィールドです。
-
email :任意の文字列。(一意)ユーザーのメールアドレスです。
-
email_verified :ブール値。ユーザーのメールアドレスが検証済みかを示します。
-
family_name :任意の文字列。ユーザーの姓です。
-
given_name :任意の文字列。ユーザーの名です。
-
name :任意の文字列。ユーザーのフルネームです。
-
nickname :任意の文字列。ユーザーのニックネームです。
-
picture :任意の文字列。
ユーザーのプロフィール画像をポイントするURLです。
-
user_id :文字列。(一意)ユーザーの一意の識別子です。
-
user_metadata :辞書。勤務先の住所、自宅の住所、ユーザーの設定など、ユーザーのアクセスに影響を与えないユーザー情報を保管するカスタムフィールドです。
-
username :任意の文字列。(一意)ユーザーのユーザー名です。
|