イベントオブジェクト

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

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

Event Object

{
  "secrets": {},
  "accessToken": {
    "customClaims": {},
    "scope": []
  },
  "client": {
    "client_id": "string",
    "metadata": {},
    "name": "string"
  },
  "request": {
    "body": {},
    "geoip": {},
    "ip": "string",
    "method": "string"
  },
  "resource_server": {
    "identifier": "string"
  },
  "tenant": {
    "id": "string"
  },
  "transaction": {
    "requested_scopes": []
  }
}

​

event.accessToken

event.accessToken · object

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

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

customClaims · dictionary

scope · array of string

​

event.agent

event.agent · object · optional

[早期アクセス] このフローで動作するエージェントに関する情報です。トークンをリクエストするクライアントがエージェントにリンクされ、かつテナントでエージェントをプリンシパルとして使用する機能が有効になっている場合に設定されます。それ以外の場合はundefinedです。

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

agent_id · string

[早期アクセス] agt_で始まるエージェントの固定識別子 (例: agt_2hVk6JxPxbRgNZDKfJQqmn) 。

agent_metadata · dictionary

[早期アクセス] エージェントに関連付けられた自由形式のキーと値のメタデータ。agentが存在する場合は常に定義され、エージェントにメタデータがない場合は空のオブジェクトになります。

name · string

[早期アクセス] エージェントの人間が理解しやすい名前。

​

event.client

event.client · object

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

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

client_id · string

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

metadata · dictionary

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

name · string

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

​

event.custom_domain

event.custom_domain · object · optional

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

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

domain · string

カスタムドメイン名。

domain_metadata · dictionary

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

​

event.organization

event.organization · dictionary · optional

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

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

id · string

組織ID。

display_name · string

組織の表示名。

metadata · dictionary

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

name · string

組織の名前。

​

event.request

event.request · object

トランザクションを開始したリクエストに関する詳細。

非表示 リクエストのプロパティ

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

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

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

identifier · string

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

​

event.secrets

event.secrets · secrets

このActionに安全に紐付けられたSecretの値。

​

event.tenant

event.tenant · object

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

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

id · string

テナントの名前。

​

event.transaction

event.transaction · object

資格情報交換トランザクションに関する情報。

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

correlation_id · string · optional

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

requested_scopes · array of string

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

target_scopes · array of string · optional

[早期アクセス] アクセストークンのターゲットスコープセットの現在の値。クライアントグラントから初期化され、現在および後続のActionsでapi.transactionのターゲットスコープメソッドによって即座に更新されます。すべてのActionsが完了すると、これらのスコープはクライアントグラントと共通するものだけが残ります。グラントに含まれないスコープは、最終的なアクセストークンから通知なく除外されます。