Actions トリガー: credentials-exchange - event オブジェクト

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

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

​

event.accessToken

event.accessToken · dictionary

発行されるアクセストークンに関する情報です。

非表示 accessToken のプロパティ

customClaims · dictionary

scope · array of strings

​

event.client

event.client · dictionary

このトークン交換で使用されるクライアントに関する情報です。

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

client_id · string

ユーザーがログインするアプリケーションの client_id です。

metadata · dictionary

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

name · string

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

​

event.custom_domain

event.custom_domain · dictionary · optional

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

非表示 custom_domain のプロパティ

domain · string

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

domain_metadata · dictionary

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

​

event.organization

event.organization · dictionary · optional

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

非表示 組織のプロパティ

id · string

組織の識別子です。

display_name · string

組織の表示名です。

metadata · dictionary

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

name · string

組織の名前です。

​

event.request

event.request · dictionary

トランザクションを開始したリクエストの詳細です。

非表示 request プロパティ

body · dictionary

POST リクエストの本文です。このデータは、リフレッシュトークン、Client Credential Exchange フロー、および PreUserRegistration Action でのみ利用できます。

geoip · dictionary

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

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

language · string · optional

ブラウザーが要求した言語です。

method · string

リクエストに使用される HTTP メソッドです

user_agent · string · optional

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

​

event.resource_server

event.resource_server · object

アクセストークンを発行するリソースサーバーに関する情報です。

非表示 resource_server のプロパティ

identifier · string

リソースサーバーの識別子です。例: https://your-api.example.com。

​

event.secrets

event.secrets · secrets

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

​

event.tenant

event.tenant · object

このトークン交換時に使用されるテナントに関する情報です。

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

id · string

テナント名です。

​

event.transaction

event.transaction · object

Credentials Exchange トランザクションに関する情報です。

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

correlation_id · string · optional

Correlation ID は、アプリケーションが Universal Login にリダイレクトする際の最初の認証リクエストで指定できます。この値を使用すると、Action コードからのログやリクエストをユーザーフローに関連付けることができます。

requested_scopes · array of strings

アクセストークンのリクエスト時に指定されたスコープです (指定されている場合) 。

target_scopes · array of strings · optional

[早期アクセス] アクセストークンの現在有効なターゲットスコープのセットです。クライアントグラントから初期化され、現在および後続の Actions にわたって api.transaction の target scope メソッドにより即座に更新されます。すべての Actions が完了すると、これらのスコープはクライアントグラントとの積集合が取られます。グラントに含まれないスコープは、最終的なアクセストークンから暗黙的に削除されます。