メインコンテンツへスキップ
custom-email-providerアクショントリガーのeventオブジェクトは、メールデータに関するコンテキスト情報を提供します。
プロパティ説明

event.client

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

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

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

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

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

  • html：文字列。レンダリングされたHTMLテンプレートです。
  • from：文字列。差出人のメールアドレスです。
  • subject：文字列。メールに付ける件名です。
  • locale：任意の文字列。en_USなど、メッセージをレンダリングするロケールで、BCP-47の仕様に従います。
  • message_type：文字列。

    verify_emailやwelcome_emailなど、送信するメッセージの種類です。

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

    • verify_email
    • verify_email_by_code
    • reset_email
    • reset_email_by_code
    • welcome_email
    • verification_code
    • mfa_oob_code
    • enrollment_email
    • blocked_account
    • stolen_credentials
    • try_provider_configuration_email
    • organization_invitation
  • text：文字列。レンダリングされたテキストのテンプレートです。
  • to：文字列。宛先のメールアドレスです。

event.organization

（任意）

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

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

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

event.request

（任意）

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

  • geoip：任意のオブジェクト

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

    • countryCode：任意の文字列
    • countryCode3：任意の文字列
    • cityName：任意の文字列
    • latitude：任意の文字列
    • longitude：任意の文字列
    • timeZone：任意の文字列
    • subdivisionCode：任意の文字列
    • subdivisionName：任意の文字列
    • continentCode：任意の文字列
  • ip：任意の文字列。要求の送信元のIPアドレスです。
  • query：任意の辞書。認可要求に送信されたクエリ文字列パラメーターです。パスワードリセットフローにのみ対応しています。
  • 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：任意の文字列。 ユーザーの（一意の）ユーザー名です。

​
もっと詳しく

⌘I