Create and register a new agent
Create and register a new agent with the Auth0 Dashboard and Management API.- Auth0 Dashboard
- Management API
- Navigate to Dashboard > Agents and select Create New Agent.
- Enter a name for the agent.
- Select Create.
agent_id with the agt_ prefix. To view the agent’s details, select View Details.Agent object
Once registered, Auth0 stores the agent with the following object schema:
The agent object is returned by all
/api/v2/agents endpoints.
external_agent_id
You can supply your own identifier for an agent using external_agent_id, so that the agent identity visible in tokens and logs matches an ID already in use in your own systems. You must specify the external_agent_id at agent creation; it cannot be added or changed afterward.
When set, the external_agent_id replaces agent_id wherever the agent’s identity appears in issued tokens (sub, act.sub) and in tenant logs. The internal agent_id remains the identifier used to manage the agent through the Management API, regardless of whether you’ve set an external_agent_id.
Do not include personally identifiable information (PII) in
external_agent_id. This value is recorded in logs and may be visible to administrators and log streaming destinations.Next steps
- Associate agent with a client to issue tokens with agent identity