エージェントの登録

Auth0 Dashboard または Management API を使用してエージェントを作成・登録する

Auth0 Dashboard または Management API を使用して、エージェントをAuth0の第一級アイデンティティとして登録します。登録後は、標準的なCRUD操作を使用して、Management API でエージェントを管理できます。

​

新しいエージェントを作成して登録する

Auth0 Dashboard と Management API を使用して、新しいエージェントを作成・登録します。

Auth0 Dashboard

1. Dashboard > Agents に移動し、Create New Agent を選択します。
2. エージェントの名前を入力します。
3. Create を選択します。

正常に作成されると、エージェントには agt_ プレフィックス付きの一意の agent_id が割り当てられます。エージェントの詳細を表示するには、詳細を表示 を選択します。

Management API

まず、Management API access トークン に create:agents permission があることを確認します。

次に、以下のパラメータを指定して /api/v2/agents に POST request を送信します。

curl --request POST \
  --url 'https://YOUR_AUTH0_DOMAIN/api/v2/agents' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_MGMT_API_TOKEN' \
  --data '{
    "name": "recommendation-agent-prod",
    "external_agent_id": "my-org-agent-042",
    "metadata": {
      "env": "prod",
      "team": "personalization"
    }
  }'

フィールド	必須	説明
name	はい	1～255文字。
client_id	いいえ	エージェントの作成時に既存のクライアントを関連付けます。
external_agent_id	いいえ	作成時にのみ設定できます。後から変更することはできません。詳細については、external_agent_idを参照してください。
metadata	いいえ	JSON、上限10 KB。

name または metadata フィールドに個人を特定できる情報 (PII) を含めないでください。これらの値はログに記録され、管理者やログストリーミングの宛先から閲覧できる場合があります。

成功すると、Auth0 は次のようなエージェントオブジェクトを返します。

{
    "agent_id": "agt_sJsP2T4rLopMQMWz2eEGmW",
    "name": "recommendation-agent-prod",
    "metadata": {
        "env": "prod",
        "team": "personalization"
    },
    "created_at": "2026-07-28T21:40:01.395Z",
    "updated_at": "2026-07-28T21:40:01.395Z",
    "external_agent_id": "my-org-agent-042"
}

​

Agent オブジェクト

登録後、Auth0 は以下のオブジェクトスキーマでエージェントを保存します。

フィールド	型	説明
agent_id	文字列	サーバーによって生成されます。形式: agt_ + 22 文字のbase58文字。変更できません。external_agent_id が設定されている場合でも、Management API を介してエージェントを指定する際には常に使用されます。
external_agent_id	文字列	任意。顧客が指定する識別子です。作成時に設定する必要があり、後から追加または変更することはできません。設定されている場合、トークンのクレームおよびテナントログでは agent_id の代わりに使用されます。
name	文字列	1～255文字。作成時に必須です。
metadata	オブジェクト	JSON、上限10 KB。
created_at	文字列	ISO 8601タイムスタンプ。
updated_at	文字列	ISO 8601タイムスタンプ。

エージェントオブジェクトは、すべての /api/v2/agents エンドポイントから返されます。

​

external_agent_id

external_agent_id を使用すると、エージェントに独自の識別子を指定できます。これにより、トークン や ログ に表示されるエージェントのアイデンティティを、自社システムですでに使用している ID と一致させることができます。external_agent_id はエージェントの作成時に指定する必要があり、後から追加または変更することはできません。

external_agent_id を設定すると、発行される トークン (sub、act.sub) およびテナントログ内でエージェントのアイデンティティが表示されるすべての箇所で、agent_id の代わりに external_agent_id が使用されます。external_agent_id の設定有無にかかわらず、内部の agent_id は Management API を通じてエージェントを管理する際の識別子として使用されます。

external_agent_id には個人を特定できる情報 (PII) を含めないでください。この値は ログ に記録され、管理者やログストリーミングの宛先から閲覧できる場合があります。

​

次のステップ

• エージェント をクライアントに関連付け、エージェント アイデンティティを持つトークンを発行する