メインコンテンツへスキップ
プロパティ説明

event.authentication

(任意)

ログインフロー中に取得した認証シグナルについての詳細です。

以下のプロパティを含みます。

  • methods

    ユーザーがセッション中に完了した認証方式を含みます。

    配列要素:

    • 以下のオブジェクトスキーマの1つです。

      • 以下のプロパティを持つオブジェクトです。

        • name

          完了した第一要素の名前です。値には以下が含まれます。

          • “federated”:ソーシャル接続またはエンタープライズ接続を第一要素としてユーザーを認証しました。
          • “pwd”:パスワードを第一要素としてデータベース接続のユーザーを認証しました。
          • “passkey”:パスキーを第一要素としてデータベース接続のユーザーを認証しました。
          • “sms”:パスワードレスのSMS接続を第一要素としてユーザーを認証しました。
          • “email”:パスワードレスのメール接続をを第一要素としてユーザーを認証したか、またはパスワードリセットのための確認メールです。
          • “phone_number”:電話番号を使用してパスワードをリセットしました。
          • “mock”:内部テストに使用されます。
          • string:URLで指定されたカスタムの認証方法(第二以降の要素として)です。
        • timestamp:文字列
      • 以下のプロパティを持つオブジェクトです。

        • name:“mfa”の値です。ユーザーが多要素認証(第二以降の要素として)を完了しました。
        • timestamp:文字列
  • riskAssessment

    ログインまたはパスワードリセットフロー中に取得したリスク評価についての詳細です。

    以下のプロパティを含みます。

    • assessments

      以下のプロパティを含みます。

      • ImpossibleTravel

        ユーザーが不可能な移動を示す場所からログインしているかを判定します。

        以下のプロパティを含みます。

        • code

          可能な値には以下が含まれます。

          • minimal_travel_from_last_login
          • travel_from_last_login
          • substantial_travel_from_last_login
          • impossible_travel_from_last_login
          • invalid_travel
          • missing_geoip
          • anonymous_proxy
          • unknown_location
          • initial_login
          • location_history_not_found
          • assessment_not_available
        • confidence

          可能な値には以下が含まれます。

          • low
          • medium
          • high
          • neutral
      • NewDevice

        ユーザーが既知のデバイスからログインしているかを判定します。

        以下のプロパティを含みます。

        • code

          可能な値には以下が含まれます。

          • match
          • partial_match
          • no_match
          • initial_login
          • unknown_device
          • no_device_history
          • assessment_not_available
        • confidence

          可能な値には以下が含まれます。

          • low
          • medium
          • high
          • neutral
        • details

          以下のプロパティを含みます。

          • device

            可能な値には以下が含まれます。

            • known
            • unknown
          • useragent

            可能な値には以下が含まれます。

            • known
            • unknown
      • UntrustedIP

        IPアドレスがAuth0の低信頼IPのリポジトリにあるかを示します。

        以下のプロパティを含みます。

        • code

          可能な値には以下が含まれます。

          • not_found_on_deny_list
          • found_on_deny_list
          • invalid_ip_address
          • assessment_not_available
        • confidence

          可能な値には以下が含まれます。

          • low
          • medium
          • high
          • neutral
        • details

          以下のプロパティを含みます。

          • category:任意の文字列
          • ip:任意の文字列要求の送信元のIPアドレスです。
          • matches:任意の文字列
          • source:任意の文字列
    • confidence

      全体的なリスクスコアです。

      可能な値には以下が含まれます。

      • low
      • medium
      • high
      • neutral
    • version:文字列

event.authorization

(任意)

ログインしようとしているユーザーに付与された認可を説明する情報を含むオブジェクトです。

以下のプロパティを含みます。

  • roles:文字列の配列ユーザにー割り当てられたロール名を含む配列です。

event.client

このログイントランザクションを開始した相手であるクライアントの情報です。

以下のプロパティを含みます。

  • client_id:文字列ユーザーがログインしようとしているアプリケーションのクライアントIDです。
  • metadata:辞書アプリケーションの他のプロパティを含むオブジェクトです。
  • name:文字列アプリケーションの名前(ダッシュボードで定義)です。

event.connection

ユーザーの認証に使用された接続についての詳細です。

以下のプロパティを含みます。

  • id:文字列接続の一意の識別子です。
  • metadata:任意の辞書接続に付けられているメタデータです。
  • name:文字列ユーザーの認証に使用した接続の名前(twittersome-g-suite-domainなど)です。
  • strategy:文字列接続の種類です。ソーシャル接続の場合はevent.connection.strategy === event.connection.nameです。エンタープライズ接続の場合はwaad(Windows Azure AD)、ad(Active Directory/LDAP)、auth0(データベース接続)などです。

event.organization

(任意)

現在のトランザクションに関連付けられているOrganizationについての詳細です。

以下のプロパティを含みます。

  • display_name:文字列Organizationのフレンドリー名です。
  • id:文字列Organizationの識別子です。
  • metadata:辞書Organizationに関連付けられているメタデータです。
  • name :文字列Organizationの名前です。

event.prompt

(任意)

レンダリングされたカスタムプロンプトから収集したデータです。

以下のプロパティを含みます。

  • fields:任意の辞書フィールドと隠しフィールドのデータです。
  • id:文字列プロンプトIDです。
  • vars:任意の辞書共有変数のデータです。

event.refresh_token

(任意)

[エンタープライズ顧客]現在のリフレッシュトークンです。

以下のプロパティを含みます。

  • client_id:任意の文字列[エンタープライズ顧客]リフレッシュトークンに関連付けられているクライアントのIDです。
  • created_at:文字列[エンタープライズ顧客]リフレッシュトークンが作成された時点のタイムスタンプです。
  • device

    以下のプロパティを含みます。

    • initial_asn:任意の文字列[エンタープライズ顧客]このリフレッシュトークンに関連付けられている最初のAS番号です。
    • initial_ip:任意の文字列[エンタープライズ顧客]このリフレッシュトークンに関連付けられている最初のIPアドレスです。
    • initial_user_agent:任意の文字列[エンタープライズ顧客]このリフレッシュトークンに関連付けられている最初のユーザエージェントです。
    • last_asn:任意の文字列[エンタープライズ顧客]このリフレッシュトークンが最後に交換された最後のAS番号です。
    • last_ip:任意の文字列[エンタープライズ顧客]このリフレッシュトークンが最後に交換された最後のIPアドレスです。
    • last_user_agent:任意の文字列[エンタープライズ顧客]このリフレッシュトークンが最後に交換されたデバイスの最後のユーザエージェントです。
  • expires_at:任意の文字列[エンタープライズ顧客]リフレッシュトークンが失効する絶対有効期限日のタイムスタンプです。
  • id:文字列[エンタープライズ顧客]リフレッシュトークンのIDです。
  • idle_expires_at:任意の文字列[エンタープライズ顧客]リフレッシュトークンが失効するアイドル有効期限日のタイムスタンプです。
  • last_exchanged_at:任意の文字列[エンタープライズ顧客]リフレッシュトークンが最後に交換に成功したときのタイムスタンプです。
  • resource_servers

    要素は以下のプロパティを含みます。

    • audience:文字列[エンタープライズ顧客]リフレッシュトークンのオーディエンスです。
    • scopes:文字列[エンタープライズ顧客]リフレッシュトークンのスコープです。
  • rotating:任意のブール値[エンタープライズ顧客]リフレッシュトークンがローテーションするリフレッシュトークンかどうかです。
  • session_id:任意の文字列[エンタープライズ顧客]リフレッシュトークンにバインドされたセッションのIDです。
  • user_id:任意の文字列[エンタープライズ顧客]リフレッシュトークンにバインドされたユーザのIDです。

event.request

トランザクションを開始した要求についての詳細です。

以下のプロパティを含みます。

  • asn:任意の文字列要求を行っているユーザエージェントのAS番号です。
  • body:辞書POST要求本文です。このデータはリフレッシュトークンとクライアント資格情報交換、ログイン後アクションの実行中にのみ利用可能です。
  • geoip

    以下のプロパティを含みます。

    • cityName:任意の文字列
    • continentCode:任意の文字列
    • countryCode:任意の文字列
    • countryCode3:任意の文字列
    • countryName:任意の文字列
    • latitude:任意の数値
    • longitude:任意の数値
    • subdivisionCode:任意の文字列
    • subdivisionName:任意の文字列
    • timeZone:任意の文字列
  • hostname:任意の文字列認証フローで使用されるホスト名です。
  • ip:文字列要求の送信元のIPアドレスです。
  • language:任意の文字列ブラウザーが要求した言語です。
  • method:文字列要求が使用したHTTPメソッドです。
  • query:辞書認可要求に送信されたクエリ文字列パラメーターです。
  • user_agent:任意の文字列トランザクションの開始時に受信したUser-Agentヘッダーの値です。

event.resource_server

(任意)

アクセスの要求対象であるリソースサーバーについての詳細です。

以下のプロパティを含みます。

event.session

(任意)

現在のログインセッションです。

以下のプロパティを含みます。

  • authenticated_at:任意の文字列[エンタープライズ顧客]セッションが最後に認証された日付と時間です。
  • clients

    [エンタープライズ顧客]セッションのためのクライアント詳細のリストです。

    要素は以下のプロパティを含みます。

    • client_id:文字列[エンタープライズ顧客]セッションのクライアントIDです。
  • created_at:任意の文字列[エンタープライズ顧客]セッションが作成された日付と時間です。
  • device

    [エンタープライズ顧客]セッションで使用されたデバイスに関連したメタデータです。

    以下のプロパティを含みます。

    • initial_asn:任意の文字列[エンタープライズ顧客]このセッションに関連付けられている最初のAS番号です。
    • initial_ip:任意の文字列[エンタープライズ顧客]このセッションに関連付けられている最初のIPアドレスです。
    • initial_user_agent:任意の文字列[エンタープライズ顧客]このセッションに関連付けられているデバイスの最初のユーザエージェントです。
    • last_asn:任意の文字列[エンタープライズ顧客]このユーザが最後のログインを行ったログイン元のAS番号です。
    • last_ip:任意の文字列[エンタープライズ顧客]このユーザが最後のログインを行ったログイン元のIPアドレスです。
    • last_user_agent:任意の文字列[エンタープライズ顧客]このユーザが最後のログインを行ったログイン元のデバイスの最後のユーザエージェントです。
  • expires_at:任意の文字列[エンタープライズ顧客]セッションの有効期限が切れる日付と時間です。
  • id:文字列現在のセッションのIDです。
  • idle_expires_at:任意の文字列[エンタープライズ顧客]アイドル状態のセッションが失効する日付と時間です。
  • last_interacted_at:任意の文字列[エンタープライズ顧客]セッションで最後に対話があった日付と時間です。
  • updated_at:任意の文字列[エンタープライズ顧客]セッションが最後に更新された日付と時間です。
  • user_id:任意の文字列[エンタープライズ顧客]別のAPIとの対話に使用可能なユーザーIDです。

event.stats

現在のユーザーのログイン統計です。

以下のプロパティを含みます。

  • logins_count:数値このユーザがこれまでにログインした回数です。

event.tenant

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

以下のプロパティを含みます。

  • id:文字列テナントの名前です。

event.transaction

(任意)

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

以下のプロパティを含みます。

  • acr_values:文字列の配列元の認証要求で提供された任意のacr_valuesです。
  • linking_id:任意の文字列開発者がこのトランザクションを参照するためのダイナミックリンクIDです。
  • locale:文字列このトランザクションに使用されるロケールです。ブラウザーが要求した言語とテナントの言語設定を比較して決定されます。
  • login_hint:任意の文字列エンドユーザーが(必要であれば)使用するかもしれないログイン識別子について認証サーバーに提供するヒントです。
  • prompt:任意の文字列配列ユーザーに再認証や同意を求めるかを示す指示のリストです。
  • protocol

    可能な値には以下が含まれます。

    • oidc-basic-profile:最も使用頻度の高いWebベースのログインです。
    • oidc-ciba:CIBA(Client-Initiated Backchannel Authentication)フローで使用されます。
    • oidc-implicit-profile:モバイルデバイスやシングルページアプリで使用されます。
    • oidc-hybrid-profile:アクセストークンとリフレッシュトークンを安全に取得しながら、アプリケーションがIDトークンに即座にアクセスできるようにします。
    • samlp :SaaSアプリで使用されるSAMLプロトコルです。
    • wsfed:Office365などのMicrosoft社製品で使用されるWS-Federationです。
    • wstrust-usernamemixed:CRMやOffice365で使用されるWS-trustのユーザ名/パスワードです。
    • oauth2-device-code:デバイス認可フローを使用したトランザクションです。
    • oauth2-resource-owner:データベース接続で一般的に使用されるユーザ名/パスワードによるログインです。
    • oauth2-resource-owner-jwt-bearer:ユーザーの秘密鍵で署名されたベアラーJWTを使用したログインです。
    • oauth2-password:パスワード交換を使用したログインです。
    • oauth2-webauthn:webauthn交換を使用したログインです。
    • oauth2-access-token:リフレッシュトークンの交換を使用したトークンの更新です。
    • oauth2-refresh-token:リフレッシュトークンの交換を使用したトークンの更新です。
    • oauth2-token-exchange
  • redirect_uri:任意の文字列トランザクションの完了後、Auth0がブラウザーのリダイレクト先に使用するURLです。
  • requested_authorization_details

    https://datatracker.ietf.org/doc/html/draft-ietf-oauth-rar#section-2が提供するRich Authorization Requests仕様のセクション2を基にしたリッチ認証要求についての詳細です。

    要素は以下のプロパティを含みます。

    • type:文字列認証タイプの詳細の文字列です。タイプフィールドの値がオブジェクトに含められる内容を決定します。
  • 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:辞書サポートプラン、セキュリティロール、アクセス制御グループなど、ユーザーのアクセスに影響を与えるユーザー情報を保管しているカスタムフィールドです。
  • created_at:文字列ユーザーのプロファイル情報が最初に作成されたときを示すタイムスタンプ。
  • email:任意の文字列ユーザーの(一意の)メールアドレスです。
  • email_verified:ブール値ユーザーに確認済みのメールアドレスがあるかを示します。
  • enrolledFactors

    ユーザーが登録した認証要素の配列です。

    配列要素:

    • 登録済みの認証要素の種類と要素特有のオプションを記述したオブジェクトです。

      以下のプロパティを含みます。

      • options:任意の辞書登録された要素を説明する追加のオプションです。
      • type:文字列push-notificationphoneemailotpwebauthn-roamingwebauthn-platformなど、認証要素の種類です。
  • family_name:任意の文字列ユーザーの姓です。
  • given_name:任意の文字列ユーザーの名です。
  • identities

    ユーザーが元の認証に使用したIDプロバイダーから取得した情報が含まれます。ユーザーがプロファイルを複数のIDロバイダーにをリンクしているかもしれません。そのようなアイデンティティもこの配列に含まれます。IDプロバイダーオブジェクトのコンテンツはプロバイダーに依存します。

    要素は以下のプロパティを含みます。

    • connection:任意の文字列ユーザーの認証に使用されたAuth0接続の名前です。
    • isSocial:任意のブール値接続がソーシャル接続がを示します。
    • profileData:任意の辞書接続に関連付けられているユーザー情報です。プロファイルがリンクされている場合は、セカンダリーアカウントのユーザー情報も含まれます。
    • provider:任意の文字列Facebook、Google、SAML、独自のプロバイダーなど、ユーザーを認証するエンティティの名前です。
    • user_id:任意の文字列この接続またはプロバイダーでユーザーに一意の識別子です。
  • last_password_reset:任意の文字列ユーザーのパスワードが最後にリセットまたは変更されたときを示すタイムスタンプです。ユーザー作成時にはこのフィールドは存在しません。このプロパティはデータベース接続にのみ存在します。
  • multifactor:任意の文字列配列ユーザーが登録した多要素認証(MFA)プロバイダーのリストです。この配列は、ユーザーがMFAに登録したときと、管理者がユーザーのMFA登録をリセットしたときに更新されます。
  • name:任意の文字列ユーザーのフルネームです。
  • nickname:任意の文字列ユーザーのニックネームです。
  • phone_number:任意の文字列ユーザーの電話番号です。
  • phone_verified:任意のブール値ユーザーの電話番号検証が完了したかを示します。
  • picture:任意の文字列ユーザーのプロフィール画像をポイントするURLです。
  • updated_at:文字列ユーザーのプロファイル情報が最後に更新または変更されたときを示すタイムスタンプです。
  • user_id:文字列ユーザーの(一意の)識別子です。
  • user_metadata:辞書勤務先の住所、自宅の住所、ユーザー設定など、アクセス権に影響を与えないユーザー情報を保管するカスタムフィールドです。
  • username:任意の文字列ユーザーの(一意の)ユーザー名です。