メインコンテンツへスキップ
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

現在のトランザクションに関連するテナントの詳細。

次のプロパティを含みます：

  • id 文字列。テナント名。

event.transaction

現在のトランザクションについての詳細。

次のプロパティを含みます：

  • acr_values 文字列の配列。 元の認証要求に提供されたすべてのacr_values。
  • locale 文字列。このトランザクションに使われるロケールで、 ブラウザーの要求言語とテナントの言語設定を 比較して決定される。
  • login_hint 任意の文字列。エンドユーザーが必要な場合にログインに使用する可能性のある、 ログイン識別子に関する認可サーバーへのヒント。
  • prompt 任意の文字列の配列。ユーザーに再認証と同意を求めるかどうかを示す 指示のリスト。
  • protocol 任意の文字列。

    含まれる可能性のある値は以下の通りです：

    • oidc-basic-profile 最も使用される、Webベースのログイン。
    • oidc-implicit-profileモバイルデバイスおよびシングルページアプリで使用されます。
    • samlp SaaSアプリで使用されるSAMLプロトコール。
    • wsfedOffice365といったMicrosoft製品で使用されるWS-Federation 。
    • wstrust-usernamemixedCRMおよびOffice365で使用されるWS-trustユーザー/パスワードログイン。
    • oauth2-device-code デバイスの認可フローで使用されるトランザクション。
    • oauth2-resource-owner通常、データベース接続に使用されるユーザー/パスワード ログイン。
    • oauth2-resource-owner-jwt-bearerユーザーの秘密鍵で署名されたBearerを使用したログイン。
    • oauth2-password パスワード交換を使用したログイン。
    • oauth2-access-tokenリフレッシュトークン交換を使用したトークンのリフレッシュ。
    • oauth2-refresh-tokenリフレッシュトークン交換を使用したトークンのリフレッシュ。
    • oauth2-token-exchange
    • oidc-hybrid-profileアクセストークンとリフレッシュトークンをアプリケーションが 安全に取得できるようにしながら、 IDトークンに即座にアクセスできるようにします。
  • redirect_uri 任意の文字列。トランザクションが完了した後にAuth0がリダイレクトするブラウザーのURL。
  • requested_scopes 文字列の配列。この認証フローを開始するときに要求（必要ある場合）される スコープ。
  • response_mode 任意の文字列。

    認可エンドポイントから返されたパラメーターに使用される 認可サーバーのメカニズムに知らせます。

    含まれる可能性のある値は以下の通りです：

    • query
    • fragment
    • form_post
    • web_message
  • response_type 任意の文字列の配列。

    含まれる可能性のある値は以下の通りです：

    • code
    • token
    • id_token
  • state 任意の文字列。Auth0がリダイレクトしてアプリケーションに戻る際に含まれ、 アプリが初期要求に追加する不透明な 任意の英数字の文字列。
  • ui_locales 文字列の配列。 元の認証要求で提供されたui_locales。

event.user

登録を試みているユーザーを説明するオブジェクト。

次のプロパティを含みます：

  • app_metadata 任意の辞書。サポートプラン、セキュリティロール、アクセス制御グループなどの ユーザーアクセスに影響するユーザーについての情報を保存する カスタムフィールドです。
  • email 任意の文字列。 （一意）ユーザーのメールアドレス。
  • family_name 任意の文字列。ユーザーの姓。
  • given_name 任意の文字列。ユーザーの名。
  • name 任意の文字列。ユーザーの氏名。
  • nickname 任意の文字列。 ユーザーのニックネーム。
  • phone_number 任意の文字列。 ユーザーの電話番号。
  • picture 任意の文字列。ユーザーのプロファイル写真を指すURL。
  • user_metadata 任意の辞書。勤務先住所、自宅住所、ユーザーの設定など、 ユーザーのアクセスに影響を与えないユーザーの情報を 保存するカスタムフィールド。
  • username 任意の文字列。 （一意）ユーザーのユーザー名。
⌘I