アクショントリガー:pre-user-registration - Eventオブジェクト
pre-user-registrationアクショントリガーの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 (Microsoft Entra ID)、ad (Active
Directory/LDAP)、auth0 (データベース接続)など
です。
|
event.request
|
トランザクションを開始した要求の詳細。
次のプロパティを含みます:
body 辞書。POST要求のボディ。このデータは、
リフレッシュトークン、クライアント資格情報交換フロー、
PreUserRegistrationアクション中のみ利用できます。
-
geoip オブジェクト。次のプロパティを含みます:
cityName 任意の文字列。
continentCode 任意の文字列。
countryCode 任意の文字列。
countryCode3 任意の文字列。
countryName 任意の文字列。
latitude 任意の数字。
longitude 任意の数字。
subdivisionCode 任意の文字列。
subdivisionName 任意の文字列。
timeZone 任意の文字列。
hostname 任意の文字列。認証フローに使用されている
ホスト名。
-
ip 文字列。要求の発生元IPアドレス。
-
language 任意の文字列。ブラウザーから要求された言語。
-
method 文字列。要求に使用されたHTTPメソッド
-
user_agent 任意の文字列。トランザクションの開始時に受け取ったUser-Agent の
ヘッダーの値。
|
event.tenant
|
現在のトランザクションに関連するテナントの詳細。
次のプロパティを含みます:
|
event.transaction
(任意)
|
現在のトランザクションについての詳細。
次のプロパティを含みます:
|
event.user
|
登録を試みているユーザーを説明するオブジェクト。
次のプロパティを含みます:
app_metadata 任意の辞書。サポートプラン、セキュリティロール、アクセス制御グループなどの
ユーザーアクセスに影響するユーザーについての情報を保存する
カスタムフィールドです。
-
email 任意の文字列。
(一意)ユーザーのメールアドレス。
-
family_name 任意の文字列。ユーザーの姓。
-
given_name 任意の文字列。ユーザーの名。
-
name 任意の文字列。ユーザーの氏名。
-
nickname 任意の文字列。ユーザーのニックネーム。
-
phone_number 任意の文字列。ユーザーの電話番号。
-
picture 任意の文字列。
ユーザーのプロファイル写真を指すURL。
-
user_metadata 任意の辞書。勤務先住所、自宅住所、ユーザーの設定など、
ユーザーのアクセスに影響を与えないユーザーの情報を
保存するカスタムフィールド。
-
username 任意の文字列。
(一意)ユーザーのユーザー名。
|