イベントオブジェクト

トリガーの実行に関するコンテキスト情報を提供する、custom-email-provider Action トリガーのイベントオブジェクトについて説明します。

custom-email-provider Actions トリガーの event オブジェクトは、トリガーの実行に関するコンテキスト情報を提供します。

Event Object

{
  "secrets": {},
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "notification": {
    "from": "string",
    "html": "string",
    "locale": "string",
    "message_type": "string",
    "subject": "string",
    "text": "string",
    "to": "string"
  },
  "request": {},
  "tenant": {
    "id": "string"
  },
  "user": {}
}

​

event.client

event.client · object

このログイントランザクションを開始したクライアントに関する情報。

非表示 event.client のプロパティ

client_id · string

ユーザーがログインするアプリケーションのクライアントID。

metadata · dictionary

その他のアプリケーションプロパティを格納するオブジェクト。

name · string

アプリケーションの名前 (Auth0 Dashboard で定義) 。

​

event.connection

event.connection · object · optional

ユーザーの認証に使用された接続の詳細。

非表示 event.connection のプロパティ

id · string

接続の一意の識別子。

metadata · dictionary · optional

接続に関連付けられたメタデータ。

name · string

ユーザーの認証に使用された接続の名前 (twitter や some-g-suite-domain など) 。

strategy · string

接続の種類。ソーシャル接続の場合、event.connection.strategy === event.connection.name となります。エンタープライズ接続の場合、strategy には waad (Windows Azure AD) 、ad (Active Directory/LDAP) 、auth0 (データベース接続) などがあります。

​

event.custom_domain

event.custom_domain · object · optional

現在のトランザクションに関連付けられたカスタムドメインの詳細です。

非表示 event.custom_domain のプロパティ

domain · string

カスタムドメイン名。

domain_metadata · dictionary

キーと値のペアで構成されるカスタムドメインのメタデータ。

​

event.notification

event.notification · object

非表示 event.notification のプロパティ

from · string

メールの送信者のメールアドレス。

html · string

レンダリングされた HTML テンプレート。

locale · string

メッセージのレンダリングに使用したロケール。BCP-47 仕様で定義されている en_US など。

message_type · string

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

subject · string

メールに付加する件名。

text · string

レンダリングされたテキストテンプレート。

to · string

受信者のメールアドレス。

​

event.organization

event.organization · dictionary · optional

現在のトランザクションに関連付けられた組織の詳細。

非表示 event.organizationのプロパティ

id · string

組織ID。

display_name · string

組織の表示名。

metadata · dictionary

組織に関連付けられたメタデータ。

name · string

組織の名前。

​

event.request

event.request · object

非表示 event.request のプロパティ

geoip · dictionary · optional

非表示 geoip プロパティ

cityName · string · optional

continentCode · string · optional

countryCode · string · optional

countryCode3 · string · optional

countryName · string · optional

latitude · number · optional

longitude · number · optional

subdivisionCode · string · optional

subdivisionName · string · optional

timeZone · string · optional

hostname · string · optional

認証フローで使用されるホスト名。

ip · string · optional

リクエストの送信元 IP アドレス。

query · dictionary · optional

認可リクエストに送信されるクエリ文字列パラメーター。

user_agent · string · optional

トランザクション開始時に受信した User-Agent ヘッダーの値。

​

event.secrets

event.secrets · secrets

このActionに安全に関連付けられたシークレット値。

​

event.tenant

event.tenant · object

非表示 event.tenantのプロパティ

id · string

tenantの名前。

friendly_name · string · optional

tenantの表示名。通常はIDを人が理解しやすい形式にしたものです。

home_url · string · optional

定義されている場合、設定に記載されたtenantのホームURL。

logo_url · string · optional

定義されている場合、設定に記載されたtenantのロゴURL。

support_email · string · optional

定義されている場合、設定に記載されたtenantのサポート窓口のメールアドレス。

support_url · string · optional

定義されている場合、設定に記載されたtenantのサポート窓口のURL。

​

event.transaction

event.transaction · object · optional

トレーシング用の現在のトランザクションの詳細。

非表示 event.transaction プロパティ

correlation_id · string · optional

分散トレーシングのために、複数のサービスにまたがるこのリクエストを関連付ける一意の識別子。

​

event.user

event.user · dictionary

現在のトランザクションを開始したユーザーを表すオブジェクトです。

非表示 event.userのプロパティ

app_metadata · dictionary

サポートプラン、セキュリティロール、アクセス制御グループなど、ユーザーがアクセスできる内容に影響する情報を保存するCustom fieldsです。

email · string · optional

(一意の) ユーザーのメールアドレス。

email_verified · boolean

ユーザーがメールアドレスを確認済みかどうかを示します。

family_name · string · optional

ユーザーの姓。

given_name · string · optional

ユーザーの名。

name · string · optional

ユーザーの氏名。

nickname · string · optional

ユーザーのニックネーム。

picture · string · optional

ユーザーのプロフィール画像を指すURL。

user_id · string

(一意の) ユーザーの一意の識別子。

user_metadata · dictionary

勤務先住所、自宅住所、ユーザー設定など、アクセスできる内容に影響しない情報を保存するCustom fieldsです。

username · string · optional

(一意の) ユーザー名。