Skip to main content
Auth0でファーストクラスのアイデンティティとして登録すれば、エージェントを任意のOAuthクライアントに関連付けることができます。1つのエージェントを複数のクライアントに関連付けることも可能です。これは、環境別やリージョン別に分けたクライアントなど、複数のクライアントをまたいでトークンやログに単一のagent_idが表示される、1つの論理的なエージェントアイデンティティを持たせたい場合に便利です。 agent_idはクライアントオブジェクトに保存され、関連付けは動的に管理されます。 エージェントをクライアントに関連付けると、そのクライアントに発行されるトークンには、クライアントクレデンシャルグラントの場合はサブジェクト (sub) として、トークン交換や標準のログインフローの場合はアクター (act) として、エージェントのアイデンティティが含まれます。詳しくは、トークン内のエージェントアイデンティティをお読みください。
external_agent_idを設定しているかどうかにかかわらず、Management APIを通じてエージェントを管理する際に使用される識別子は、内部のagent_idのままです。

​
作成時にクライアントを関連付ける

POST /api/v2/clients でクライアントを作成するときに agent_id を設定します。
Auth0 CLIをお使いですか？まだの場合は、このコマンドを実行する前にCLIセッションのセットアップと認証を行ってください。
成功すると、設定した agent_id を含むクライアントオブジェクトがAuth0から返されます。

​
エージェントに関連付けられたクライアントを取得する

agent_idをクライアントに関連付けたら、/api/v2/clients/{id}にGETリクエストを送信してクライアントオブジェクトを取得します。
成功すると、Auth0は設定したagent_idを含むクライアントオブジェクトを返します。

​
既存のクライアントを関連付ける

既存のクライアントは、Auth0 DashboardまたはManagement APIを使って関連付けられます。
  1. Dashboard > Agentsに移動してエージェントを選択し、エージェントのApplicationsタブを開きます。
  2. Add Applicationを選択し、モーダルでエージェントに関連付けるアプリケーションを選択します。複数のアプリケーションを選択できます。
  3. Add Applicationsを選択します。
追加に成功すると、そのエージェントのApplicationsタブにアプリケーションが表示されます。

​
エージェントの関連付けを解除する

クライアントとエージェントの関連付けを解除するには、PATCH /api/v2/clients/{id} で agent_id を null に設定します。
関連付けを解除すると、以降そのクライアントに発行されるトークンにはエージェントのアイデンティティが含まれなくなります。既存のトークンは有効期限が切れるまで有効です。

​
次のステップ