イベントオブジェクト

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

Event Object

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

`event.client`

object

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

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

string

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

dictionary

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

string

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

`event.organization`

dictionary

optional

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

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

string

組織ID。

string

組織の表示名。

dictionary

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

string

組織名。

`event.request`

object

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

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

dictionary

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

dictionary

非表示 geoip のプロパティ

string

optional

string

optional

string

optional

string

optional

string

optional

number

optional

number

optional

string

optional

string

optional

string

optional

string

optional

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

string

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

string

optional

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

string

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

string

optional

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

`event.resource_server`

object

アクセスが要求されているリソースサーバーの詳細。

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

string

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

`event.secrets`

secrets

このActionに安全に関連付けられているSecretの値です。

`event.tenant`

object

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

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

string

テナントの名前。

`event.transaction`

object

現在のカスタムトークン交換トランザクションに関する詳細です。

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

string

optional

トークン交換リクエストで指定されるアクタートークン。

string

optional

トークン交換リクエストで指定するアクタートークンのタイプ。

dictionary

optional

アクタートークンが表すユーザー。このプロパティは、actor_token_type が urn:ietf:params:oauth:token-type:id_token であり、トークン交換リクエストで指定されたアクタートークンが Auth0 によって生成された有効な ID トークンである場合にのみ存在します。

非表示 actor_token_user のプロパティ

dictionary

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

string

ユーザープロファイルが最初に作成された日時を示すタイムスタンプ。

string

optional

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

boolean

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

string

optional

ユーザーの姓。

string

optional

ユーザーの名。

string

optional

ユーザーのパスワードが最後にリセットまたは変更された日時を示すタイムスタンプ。ユーザー作成時には、このフィールドは存在しません。このプロパティはデータベース接続でのみ使用できます。

string

optional

ユーザーのフルネーム。

string

optional

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

string

optional

ユーザーの電話番号。

boolean

optional

ユーザーが電話番号を確認済みかどうかを示します。

string

optional

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

string

ユーザーのプロファイルが最後に更新または変更された日時を示すタイムスタンプ。

string

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

dictionary

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

string

optional

(一意の) ユーザー名。

array of objects

optional

ユーザーが登録した認証要素の配列。

array of string

optional

ユーザーが登録している多要素認証 (MFA) プロバイダーのリスト。この配列は、ユーザーが MFA に登録したとき、および管理者がユーザーの MFA 登録をリセットしたときに更新されます。

array of objects

ユーザーが最初に認証したアイデンティティプロバイダーから取得した情報が含まれます。ユーザーはプロファイルを複数のアイデンティティプロバイダーにリンクすることもでき、そのアイデンティティもこの配列に表示されます。個々のアイデンティティプロバイダーオブジェクトの内容は、プロバイダーによって異なります。

array of string

トークン交換リクエストで要求されたスコープ (存在する場合) 。

string

Auth0 が生成するトークンの種類。例: urn:ietf:params:oauth:token-type:access_token。

string

トークン交換リクエストで指定されるサブジェクトトークン。

string

トークン交換リクエストで指定するsubject_token_type。

資格情報の交換

カスタムメールプロバイダー

カスタム電話プロバイダー

カスタムトークン交換

イベントストリーム

パスワードリセット後のチャレンジ

Post Change Password

Post Login

Post User Registration

Pre User Registration

Send Phone Message

イベントオブジェクト

`event.client`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`

​event.client

​event.organization

​event.request

​event.resource_server

​event.secrets

​event.tenant

​event.transaction

`event.client`

`event.organization`

`event.request`

`event.resource_server`

`event.secrets`

`event.tenant`

`event.transaction`