Actions トリガー: custom-email-provider - event オブジェクト

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

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

​

event.client

event.client · dictionary

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

非表示 クライアントのプロパティ

client_id · string

ユーザーがログインしようとしているアプリケーションのクライアントIDです。

metadata · dictionary

その他のアプリケーションプロパティを保持するためのオブジェクトです。

name · string

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

​

event.connection

event.connection · dictionary · optional

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

非表示 接続のプロパティ

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 · dictionary · optional

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

非表示 custom_domain のプロパティ

domain · string

カスタムドメイン名です。

domain_metadata · dictionary

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

​

event.notification

event.notification · object

非表示 notification のプロパティ

from · string

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

html · string

レンダリング済みの HTML テンプレート。

locale · string

メッセージのレンダリングに使用したロケールです。例: en_US。BCP-47 仕様で定義されます。

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

現在のトランザクションに紐付けられている組織の詳細。

非表示 組織のプロパティ

id · string

組織の識別子。

display_name · string

組織の表示名。

metadata · dictionary

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

name · string

組織名。

​

event.request

event.request · dictionary

非表示 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

非表示 テナントのプロパティ

id · string

テナント名。

friendly_name · string · optional

テナントの表示名。通常は、ID を人が読みやすい形にしたものです。

home_url · string · optional

定義されている場合は、設定に記載されたテナントのホーム URL。

logo_url · string · optional

定義されている場合は、設定に記載されたテナントのロゴ URL。

support_email · string · optional

定義されている場合は、設定に記載されたテナントのサポート用メールアドレス。

support_url · string · optional

定義されている場合は、設定に記載されたテナントのサポート URL。

​

event.transaction

event.transaction · object · optional

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

非表示 トランザクションのプロパティ

correlation_id · string · optional

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

​

event.user

event.user · dictionary

現在のトランザクションがそのユーザーに代わって開始された際の、対象ユーザーを表すオブジェクトです。

非表示 ユーザープロパティ

app_metadata · dictionary

サポートプラン、セキュリティロール、アクセス制御グループなど、ユーザーのアクセス権に影響する情報を保存するカスタムフィールドです。

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

勤務先住所、自宅住所、ユーザー設定など、ユーザーがアクセスできる内容に影響しない情報を保存するカスタムフィールドです。

username · string · optional

(一意) ユーザーのユーザー名。