エージェントをクライアントに関連付ける

Auth0 のファーストクラスアイデンティティとして登録すると、任意の OAuth クライアントにエージェントを関連付けることができます。1 つのエージェントを複数のクライアントに関連付けることも可能です。環境やリージョンごとにクライアントを分ける場合など、複数のクライアントにわたるトークンとログで単一の agent_id を持つ、論理的に同一のエージェントアイデンティティを使用したい場合に便利です。 agent_id はクライアントオブジェクトに保存され、関連付けは動的に管理されます。エージェントをクライアントに関連付けると、クライアントクレデンシャルグラントでは、そのクライアントに発行されるトークンにエージェントのアイデンティティがサブジェクト (sub) として含まれます。トークン交換および標準のログインフローでは、アクター (act) として含まれます。詳細については、トークン内のエージェントアイデンティティを参照してください。

external_agent_id を設定しているかどうかにかかわらず、内部 agent_id は Management API を通じてエージェントを管理するための識別子として使用されます。

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

POST /api/v2/clients でクライアントを作成する際に、agent_id を設定します。

Auth0 CLI
cURL

Auth0 CLI をお使いですか？まだの場合は、このコマンドを実行する前に CLI セッションのセットアップと認証を行ってください。

auth0 api post "clients" \
  --data '{
    "name": "My AI Client",
    "agent_id": "YOUR_AGENT_ID"
  }'

curl --request POST \
  --url 'https://YOUR_AUTH0_DOMAIN/api/v2/clients' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_MGMT_API_TOKEN' \
  --data '{
    "name": "My AI Client",
    "agent_id": "YOUR_AGENT_ID"
  }'

成功すると、Auth0 は設定した agent_id を含むクライアントオブジェクトを返します。

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

agent_id をクライアントに関連付けた後、/api/v2/clients/{id} に GET リクエストを送信してクライアントオブジェクトを取得します。

Auth0 CLI
cURL

auth0 api get "clients/YOUR_CLIENT_ID"

curl --request GET \
  --url 'https://YOUR_AUTH0_DOMAIN/api/v2/clients/YOUR_CLIENT_ID' \
  --header 'Authorization: Bearer YOUR_MGMT_API_TOKEN'

成功すると、Auth0 は設定した agent_id を含むクライアントオブジェクトを返します。

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

既存のクライアントは、Auth0 Dashboard または Management API を使用して関連付けることができます。

Auth0 Dashboard
Management API

Dashboard > Agents に移動し、エージェントを選択して、エージェントの アプリケーション タブを選択します。
Add Application を選択し、モーダルでエージェントに関連付けるアプリケーションを選択します。複数のアプリケーションを選択できます。
Add Applications を選択します。

追加に成功すると、アプリケーションがエージェントの アプリケーション タブに表示されます。

PATCH /api/v2/clients/{id} を使用して、既存のクライアントをエージェントに関連付けます。

Auth0 CLI
cURL

auth0 api patch "clients/YOUR_CLIENT_ID" \
  --data '{
    "agent_id": "YOUR_AGENT_ID"
  }'

curl --request PATCH \
  --url 'https://YOUR_AUTH0_DOMAIN/api/v2/clients/YOUR_CLIENT_ID' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_MGMT_API_TOKEN' \
  --data '{
    "agent_id": "YOUR_AGENT_ID"
  }'

成功すると、Auth0 は設定した agent_id を含む更新後のクライアントオブジェクトを返します。

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

クライアントとエージェントの関連付けを解除するには、PATCH /api/v2/clients/{id} を使用して agent_id を null に設定します。

Auth0 CLI
cURL

auth0 api patch "clients/YOUR_CLIENT_ID" \
  --data '{
    "agent_id": null
  }'

curl --request PATCH \
  --url 'https://YOUR_AUTH0_DOMAIN/api/v2/clients/YOUR_CLIENT_ID' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_MGMT_API_TOKEN' \
  --data '{
    "agent_id": null
  }'

関連付けを解除すると、以降クライアントに発行されるトークンにはagentのアイデンティティが含まれなくなります。既存のトークンは、有効期限が切れるまで有効です。

次のステップ

Auth0 がトークンにエージェントのアイデンティティを埋め込む方法について学ぶ

Quickstarts

Auth0 Overview

Configure Auth0

Applications

エージェントをクライアントに関連付ける

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

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

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

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

次のステップ

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

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

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

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

​次のステップ

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

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

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

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

次のステップ