---
title: "AAuth Agent Authorization | DreamFactory Docs"
source: "https://docs.dreamfactory.com/Security/aauth/overview"
canonical_url: "https://docs.dreamfactory.com/Security/aauth/overview"
converted_at: "2026-11-17T19:46:33.460Z"
format: "markdown"
converted_by: "html-to-md-ai"
---
AAuth lets AI agents call DreamFactory's REST APIs under `/api/v2` with signed HTTP requests instead of API keys. A person approves the agent, and what they approve is a **scope**, which is a DreamFactory **role**. The agent then gets exactly that role's access, acting for that person. AAuth is off until a sys admin turns it on. A request without AAuth headers gets the same status and body as before; while AAuth is on, DreamFactory's `400` and `401` "no credentials" answers also carry a discovery `Link` header.

LicensingAAuth requires a DreamFactory commercial license (Gold or Platinum).

This page explains what AAuth changes, how DreamFactory implements it and when to choose it over other authentication methods. To try it right away, follow the [quickstart](/Security/aauth/quickstart).

## Quick reference[​](#quick-reference)

ConceptValue**Admin UI path****Security > AAuth**, with the tabs Scopes, Person Servers, Agents, Activity, Grants and Try it**Where agents can use it**Every API under `/api/v2`. Not the MCP endpoints (`/mcp/...`). API keys and session tokens keep working alongside it.**Scope**An enabled DreamFactory role**Who can approve**On DreamFactory's own person server: a user who holds the scope's role, or a sys admin**Credentials**Nothing shared. Every request is signed (RFC 9421) with the agent's own key, and every token is bound to that key.**Token lifetime**Person and auth tokens last at most 1 hour. There are no refresh tokens.**Admin API**`/api/v2/system/aauth` (sys admins only)**Command line**`php artisan df:aauth status`, `php artisan df:aauth rotate-keys`, `php artisan df:aauth prune`**Protocol**draft-hardt-oauth-aauth-protocol-11 with draft-hardt-httpbis-signature-key-09 (see [Standards status](#standards-status))

## The problem with shared keys[​](#the-problem-with-shared-keys)

When an AI agent calls an API with an API key or a service account:

- The key is a bearer credential. Anyone who copies it, from a log, a configuration file or a chat transcript, can use it from anywhere until someone refreshes it.

- Nobody approves what the agent does on a person's behalf. The key's role decides, whoever the agent is working for.

- Logs show the key's app, not which agent acted for which person.

AAuth changes this:

- Each agent has its own verifiable identity, an agent id such as `aauth:[[email protected]](/cdn-cgi/l/email-protection)`, vouched for by its **agent provider**.

- A named person approves the agent on DreamFactory's consent page before it can act for them.

- Every request is signed with the agent's private key, and every token is bound to that key, so a token copied from a log is useless without the key.

- The **Activity** tab logs the agent, the person, the scope and the result of signed API requests, and keeps the rows for 30 days by default.

## Terms[​](#terms)

TermMeaningAgentSoftware that calls your APIs for a person, identified by an agent id such as `aauth:[[email protected]](/cdn-cgi/l/email-protection)`Agent providerAn https origin, such as `https://agents.example.com`, that vouches for its agents by publishing `/.well-known/aauth-agent.json` and their public keysPersonThe human the agent acts for, who approves itPerson serverWhere the person signs in and approves, and where the agent gets person and auth tokens. DreamFactory has one built in.ResourceThe API the agent calls: here DreamFactory's `/api/v2`Agent tokenIssued by the agent provider. Says which agent this is and which key it signs with.Person tokenIssued by the person server after the **identity step**: which person the agent acts forResource tokenIssued by DreamFactory in a challenge. Names the scope the request needs.Auth tokenIssued by the person server after the **scope consent**. Lets the agent call the API with that scope.ScopeA DreamFactory role that an admin offers to agents, such as `sales.read`

Every token is bound to the agent's key and lasts at most an hour (an agent token up to 24 hours).

## How it works in DreamFactory[​](#how-it-works-in-dreamfactory)

![Sequence diagram of the AAuth flow: the agent is challenged for a person token, the person signs in and continues, the agent is challenged for an auth token for scope sales.read, the person allows it, and the agent&#39;s signed request runs under that role.](data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="1100" height="1270" viewBox="0 0 1100 1270" font-family="-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif">
<title>AAuth in DreamFactory: an agent gets a person's approval</title>
<defs><marker id="ar" markerWidth="12" markerHeight="10" refX="11" refY="5" orient="auto" markerUnits="userSpaceOnUse"><path d="M0,0 L12,5 L0,10 z" fill="#1f2937"/></marker></defs>
<rect x="1.5" y="1.5" width="1097" height="1267" rx="16" ry="16" fill="#ffffff" stroke="#d1d5db" stroke-width="3"/>
<text x="550.0" y="44" font-size="26" font-weight="bold" text-anchor="middle" fill="#111827">AAuth in DreamFactory: an agent gets a person's approval</text>
<path d="M495,90 L495,80 L930,80 L930,90" fill="none" stroke="#6b7280" stroke-width="2"/>
<text x="712.5" y="72" font-size="17" font-weight="bold" text-anchor="middle" fill="#374151">Issuer https://api.example.com</text>
<rect x="75.0" y="98" width="310" height="78" rx="8" fill="#f3f4f6" stroke="#374151" stroke-width="2"/>
<text x="230" y="132" font-size="19" font-weight="bold" text-anchor="middle" fill="#111827">Agent</text>
<text x="230" y="154" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">aauth:reports@agents.example.com</text>
<rect x="495.0" y="98" width="210" height="78" rx="8" fill="#e0ecff" stroke="#374151" stroke-width="2"/>
<text x="600" y="132" font-size="19" font-weight="bold" text-anchor="middle" fill="#111827">DreamFactory API</text>
<text x="600" y="154" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">/api/v2 (resource)</text>
<rect x="730.0" y="98" width="200" height="78" rx="8" fill="#e0ecff" stroke="#374151" stroke-width="2"/>
<text x="830" y="122" font-size="19" font-weight="bold" text-anchor="middle" fill="#111827">DreamFactory</text>
<text x="830" y="143" font-size="19" font-weight="bold" text-anchor="middle" fill="#111827">person server</text>
<text x="830" y="164" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">/aauth</text>
<rect x="935.0" y="98" width="150" height="78" rx="8" fill="#f3f4f6" stroke="#374151" stroke-width="2"/>
<text x="1010" y="122" font-size="19" font-weight="bold" text-anchor="middle" fill="#111827">Person</text>
<text x="1010" y="143" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">Jordan Lee,</text>
<text x="1010" y="164" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">in a browser</text>
<line x1="230" y1="176" x2="230" y2="1110" stroke="#9ca3af" stroke-width="2" stroke-dasharray="7,6"/>
<line x1="600" y1="176" x2="600" y2="1110" stroke="#9ca3af" stroke-width="2" stroke-dasharray="7,6"/>
<line x1="830" y1="176" x2="830" y2="1110" stroke="#9ca3af" stroke-width="2" stroke-dasharray="7,6"/>
<line x1="1010" y1="176" x2="1010" y2="1110" stroke="#9ca3af" stroke-width="2" stroke-dasharray="7,6"/>
<line x1="230" y1="238" x2="597" y2="238" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="207" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">1. GET /api/v2/sales/_table/orders</text>
<text x="415.0" y="229" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">(signed, agent token)</text>
<rect x="14" y="256" width="196" height="112" rx="8" fill="#f9fafb" stroke="#6b7280" stroke-width="2"/>
<text x="112.0" y="282" font-size="18" font-weight="bold" text-anchor="middle" fill="#111827">Agent provider</text>
<text x="112.0" y="304" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">agents.example.com</text>
<text x="112.0" y="326" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">aauth-agent.json,</text>
<text x="112.0" y="348" font-size="16" font-weight="normal" text-anchor="middle" fill="#374151">jwks.json</text>
<line x1="600" y1="330.0" x2="213" y2="330.0" stroke="#1f2937" stroke-width="3.5" stroke-dasharray="1,8" stroke-linecap="round" marker-end="url(#ar)"/>
<text x="415.0" y="299.0" font-size="17" font-weight="normal" text-anchor="middle" fill="#374151">fetch metadata and keys</text>
<text x="415.0" y="321.0" font-size="17" font-weight="normal" text-anchor="middle" fill="#374151">to verify the agent token</text>
<line x1="600" y1="432" x2="233" y2="432" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="401" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">401 AAuth-Requirement:</text>
<text x="415.0" y="423" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">requirement=person-token</text>
<line x1="230" y1="490" x2="827" y2="490" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="481" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">2. POST /aauth/person</text>
<line x1="830" y1="540" x2="233" y2="540" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="531" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">202, code 7KQM-4D2P</text>
<line x1="230" y1="590" x2="1007" y2="590" stroke="#1f2937" stroke-width="3.5" stroke-dasharray="1,8" stroke-linecap="round" marker-end="url(#ar)"/>
<text x="415.0" y="581" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">3. link and code</text>
<line x1="1010" y1="662" x2="833" y2="662" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="920.0" y="631" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">Sign in, Continue</text>
<text x="920.0" y="653" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">as Jordan</text>
<line x1="230" y1="712" x2="827" y2="712" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="703" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">4. Poll /aauth/pending/...</text>
<line x1="830" y1="762" x2="233" y2="762" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="753" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">200 person token</text>
<line x1="230" y1="812" x2="597" y2="812" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="803" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">5. GET ... (person token)</text>
<line x1="600" y1="884" x2="233" y2="884" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="853" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">401 requirement=auth-token;</text>
<text x="415.0" y="875" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">resource token (sales.read)</text>
<line x1="230" y1="934" x2="827" y2="934" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="925" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">6. POST /aauth/token</text>
<line x1="1010" y1="960" x2="833" y2="960" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="920.0" y="951" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">Allow sales.read</text>
<line x1="830" y1="1010" x2="233" y2="1010" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="1001" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">200 auth token (after polling)</text>
<line x1="230" y1="1060" x2="597" y2="1060" stroke="#1f2937" stroke-width="2.5" marker-end="url(#ar)"/>
<text x="415.0" y="1051" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">7. GET ... (auth token)</text>
<line x1="600" y1="1110" x2="233" y2="1110" stroke="#1f2937" stroke-width="2.5" stroke-dasharray="10,7" marker-end="url(#ar)"/>
<text x="415.0" y="1101" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">200 AAuth-Scope: sales.read</text>
<rect x="385" y="1122" width="430" height="38" rx="6" fill="#fff7e6" stroke="#d97706" stroke-width="2"/>
<text x="600.0" y="1149" font-size="17" font-weight="normal" text-anchor="middle" fill="#7c2d12">Runs as role Sales read for Jordan Lee</text>
<rect x="30" y="1182" width="1040" height="74" rx="10" fill="#f9fafb" stroke="#6b7280" stroke-width="2"/>
<text x="550.0" y="1210" font-size="17" font-weight="normal" text-anchor="middle" fill="#111827">Every request is signed with the agent's key (RFC 9421); tokens are bound to that key.</text>
<text x="550.0" y="1238" font-size="16" font-weight="normal" text-anchor="middle" fill="#4b5563">Solid: request. Dashed: response. Dotted: the agent shows the person a link, or a discovery fetch.</text>
</svg>
)

1. The agent calls an API, for example `GET /api/v2/sales/_table/orders`, signed with its **agent token**. DreamFactory verifies the agent against its agent provider's published metadata and keys, and answers `401` with `AAuth-Requirement: requirement=person-token`.

2. The agent asks DreamFactory's **person server** for a **person token** (`POST /aauth/person`). The answer is `202` with a link and a code, such as `7KQM-4D2P`.

3. The agent gives the link to the person. The person opens it, signs in, and clicks **Continue as** with their first name (for example **Continue as Jordan**) to confirm that the agent acts for them. This is the **identity step**.

4. The agent polls the pending request and receives the person token.

5. The agent calls the API again, signed with the person token. DreamFactory works out which scope the request needs and answers `401` with `requirement=auth-token` and a **resource token** that names the scope, here `sales.read`.

6. The agent asks the person server for an **auth token** (`POST /aauth/token`). The person clicks **Allow** for the scope on the consent card (the **scope consent**), and the agent polls until it receives the auth token. If the person ticked **Always allow** earlier for this agent and every scope it now asks for, the person server returns the auth token at once, without a consent page.

7. The agent calls the API with the auth token. DreamFactory runs the request under the scope's role and returns the response with the header `AAuth-Scope: sales.read`.

The agent then reuses its tokens until they expire and signs every request afresh. Each request and response, header by header, is in [The AAuth HTTP Exchange](/Security/aauth/http-exchange).

You can watch the whole exchange in the admin app: **Try it** runs it with a built-in agent and draws every step.

![A completed Try it run drawn as a sequence across Agent, API and Person Server, ending with the Response card: status 200 and the JSON list of orders](/assets/images/try-it-result-feb481638832bc82b616febdd431da9e.png)

### One origin, three protocol roles[​](#one-origin-three-protocol-roles)

In AAuth terms, DreamFactory plays three parts. Each publishes a metadata document:

Protocol rolePublished atWhat it doesResource`/.well-known/aauth-resource.json`Verifies signed `/api/v2` calls, sends challenges in the `AAuth-Requirement` header, and issues resource tokensPerson server`/.well-known/aauth-person.json`People sign in (with a DreamFactory account, an LDAP or Active Directory account, or single sign-on) and approve agents at `/aauth/interact`Agent provider`/.well-known/aauth-agent.json`Identity of the built-in Try it agent only. Your own agents use their own agent provider.

All three live on one https origin, the **issuer**, which you set with `DF_AAUTH_ISSUER`, for example `https://api.example.com`. If `DF_AAUTH_ISSUER` is not set, DreamFactory uses the origin of `APP_URL` when that is https. DreamFactory can also trust external person servers, so that agents approved in your organization's own person server can call it. See [Person Servers](/Security/aauth/admin-guide#person-servers).

### Scopes are roles[​](#scopes-are-roles)

AAuth adds no new permission model:

- A sys admin enables a role as a scope, and gives it a name such as `sales.read` and a description that people read when they approve, such as "Read customers and orders".

- For each request, DreamFactory asks for the least privileged enabled scope that allows it ([How DreamFactory picks a scope](/Security/aauth/admin-guide#how-dreamfactory-picks-a-scope)). Agents do not need to know your roles: the challenge tells them which scope to ask for.

- The request runs with exactly that role, so the role's service access, filters, lookups, event scripts and rate limits apply as they would for an API key with that role.

- When the approval came from DreamFactory's own person server, the approving person's DreamFactory user is attached to the session too, always without sys admin rights, so lookups, per-user limits and scripts see that person.

- People can grant only roles they hold. Sys admins can grant any enabled scope. Whoever approves, the agent never gets sys admin rights.

## What agents can and cannot do[​](#what-agents-can-and-cannot-do)

Agents can:

- Call any `/api/v2` API that their scope's role allows.

- Appear under **Security > AAuth > Agents** on their first signed request. There is no registration step.

- Reuse their person and auth tokens for up to an hour.

- Skip the scope consent when the person ticked **Always allow** for that agent and those scopes earlier.

Agents cannot:

- Use AAuth on the MCP endpoints. MCP clients keep using OAuth, or an API key where the MCP service allows it ([API Key Authentication for MCP](/AI/mcp-api-key-auth)).

- Act without a person on DreamFactory's own person server. df-aauth 0.1.0 implements the three-party mode only, so there is no equivalent of OAuth's `client_credentials`. An external person server that you trust decides for itself how it issues tokens.

- Keep working past the person token's lifetime without the person. A person token lasts at most an hour, no auth token outlives the person token behind it, and every new person token needs the person to open a link and click **Continue as** again; **Always allow** skips only the scope consent. Plan for one person interaction per hour of continuous work.

- Get more access than the approving person could grant. On DreamFactory's own person server, a person grants only roles they hold, and this is checked again on every request.

## Choosing an authentication method[​](#choosing-an-authentication-method)

MethodWho is identifiedA person approves the callerIf the credential is copiedUse it forAAuthThe agent and the person it acts forYes, per agent and scopeUseless without the agent's private keyAI agents acting for identifiable people[API key](/api-generation-and-connections/api-keys) (app)The appNoWorks for anyone until the key is refreshedUnattended services, scripts and integrationsUser session tokenA signed-in personThe person signs in themselvesWorks until it expiresApps a person uses directly[Login services](/Security/authenticating-your-apis) (OAuth, OpenID Connect, SAML, LDAP)A person, through your identity providerThe person signs inAs for a session tokenPeople signing in to DreamFactory; also usable to [approve AAuth agents](/Security/aauth/sso-approval)[MCP server](/AI/mcp-server)An OAuth user, or an API key when the MCP service allows itWith OAuth, the person signs inWorks until the OAuth token expires or the key is refreshedMCP clients such as desktop assistants[Agents service](/AI/agents)An agent record with its own API keyAn admin approves access requestsAs for an API keyAn agent registry and capability routing

Choose AAuth when an agent acts for people and you want their approval, and an Activity log of which agent acted for whom. Keep API keys for unattended jobs, where no person is available to approve.

## Requirements at a glance[​](#requirements-at-a-glance)

RequirementDetailDreamFactory7.7.1 or later 7.xLicenseAAuth requires a DreamFactory commercial license (Gold or Platinum).Package`dreamfactory/df-aauth` installed, with its tables created (`php artisan migrate`)PHP8.3 or later with the `sodium`, `openssl`, `curl`, `json` and `mbstring` extensionsIssuerOne https origin on port 443 that agents and approvers reach, such as `https://api.example.com`. It can be public or internal. See [Choose the issuer](/Security/aauth/install#choose-the-issuer).Outbound httpsDreamFactory fetches the metadata and keys of the agent providers your agents use, on public addresses unless you admit internal ones ([Private networks and custom CAs](/Security/aauth/install#private-networks-and-custom-cas))ClocksBy default, signatures are accepted within 60 seconds of DreamFactory's clock. Run NTP on DreamFactory and agent hosts.Several DreamFactory nodesA shared Redis or Memcached cache and shared consent sessions ([Several DreamFactory nodes](/Security/aauth/operations#several-dreamfactory-nodes))AgentCode you control that signs its requests: the `aauth` command, the Node or Python client that ships in `vendor/dreamfactory/df-aauth`, or any client that implements the drafts. Assistants that only speak MCP, such as desktop assistants, can't use AAuth; they keep using OAuth or API keys. See [Building an Agent with the AAuth Clients](/Security/aauth/build-an-agent).Agent providerAn https origin you control that serves `/.well-known/aauth-agent.json` and a key set (JWKS). A static host is enough.ApproverA person the agent can send a link to, at least once an hour while it works, who holds the role behind each scope the agent needs, or a sys admin

Installation and every setting are in [Installing and Configuring AAuth](/Security/aauth/install).

## Standards status[​](#standards-status)

noteAAuth is defined by individual IETF Internet-Drafts, draft-hardt-oauth-aauth-protocol-11 and draft-hardt-httpbis-signature-key-09, not by finished standards. Later revisions of the drafts may change the protocol. DreamFactory implements the three-party person-server ("PS") authorization mode of these revisions. Requests are signed with [RFC 9421](https://www.rfc-editor.org/rfc/rfc9421) HTTP message signatures, request bodies are covered with an [RFC 9530](https://www.rfc-editor.org/rfc/rfc9530) `Content-Digest`, and keys are Ed25519 or ES256. An agent that follows the drafts works with DreamFactory without DreamFactory-specific code.

Not supported in df-aauth 0.1.0: access servers, missions, sub-agents, call chaining, the revocation endpoint and multipart bodies. See [Out of scope in 0.1.0](/Security/aauth/security-model#out-of-scope-in-010).

## Next steps[​](#next-steps)

**DreamFactory admins:**

- **[Installing and Configuring AAuth](/Security/aauth/install)**: install the package, put a TLS reverse proxy in front of DreamFactory, and set the issuer

- **[Quickstart: Approve Your First Agent Call](/Security/aauth/quickstart)**: switch AAuth on and approve the built-in Try it agent

- **[Managing AAuth](/Security/aauth/admin-guide)**: every tab of Security > AAuth, who can approve what, and how to respond to an incident

- **[Approving Agents with Company Sign-In](/Security/aauth/sso-approval)**: let approvers sign in with LDAP, Active Directory or single sign-on

**Agent developers:**

- **[Building an Agent with the AAuth Clients](/Security/aauth/build-an-agent)**: give your own agent an identity and call DreamFactory from the command line, Node or Python

- **[The AAuth HTTP Exchange](/Security/aauth/http-exchange)**: the exact requests and responses, for writing a client in any language

- **[AAuth for OAuth Developers](/Security/aauth/oauth-mapping)**: how OAuth 2.0 and OpenID Connect concepts map to AAuth

**Security reviewers and operators:**

- **[AAuth Security Model](/Security/aauth/security-model)**: what DreamFactory verifies on every request, what it records, and what is left to you

- **[Operating AAuth in Production](/Security/aauth/operations)**: signing keys, backups, several nodes, monitoring and upgrades

- **[Troubleshooting AAuth](/Security/aauth/troubleshooting)**: every error an agent, approver or admin can see, and how to fix it