Skip to content

Security

Authentication schemes, credentials, and user types.

AuthCredentials

AuthCredentials dataclass

Extracted credentials from an HTTP request.

Attributes:

Name Type Description
scheme str

The authentication scheme (e.g. "bearer", "basic", "apikey").
credentials str

The raw credential value (token, key, or password).
scopes tuple[str, ...]

Optional OAuth2 scopes associated with the credentials.
Source code in src/agenticapi/security.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
@dataclass(frozen=True, slots=True)
class AuthCredentials:
    """Extracted credentials from an HTTP request.

    Attributes:
        scheme: The authentication scheme (e.g. "bearer", "basic", "apikey").
        credentials: The raw credential value (token, key, or password).
        scopes: Optional OAuth2 scopes associated with the credentials.
    """

    scheme: str
    credentials: str
    scopes: tuple[str, ...] = ()

AuthUser

AuthUser dataclass

An authenticated user.

Carried through the request lifecycle via AgentContext.metadata. The user_id field is also set on AgentContext.user_id.

Attributes:

Name Type Description
user_id str

Unique identifier for the user.
username str | None

Optional human-readable username.
roles tuple[str, ...]

Roles assigned to the user (e.g. "admin", "operator").
scopes tuple[str, ...]

OAuth2 scopes granted to this user/token.
metadata dict[str, Any]

Arbitrary additional user metadata.
Source code in src/agenticapi/security.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@dataclass(frozen=True, slots=True)
class AuthUser:
    """An authenticated user.

    Carried through the request lifecycle via ``AgentContext.metadata``.
    The ``user_id`` field is also set on ``AgentContext.user_id``.

    Attributes:
        user_id: Unique identifier for the user.
        username: Optional human-readable username.
        roles: Roles assigned to the user (e.g. "admin", "operator").
        scopes: OAuth2 scopes granted to this user/token.
        metadata: Arbitrary additional user metadata.
    """

    user_id: str
    username: str | None = None
    roles: tuple[str, ...] = ()
    scopes: tuple[str, ...] = ()
    metadata: dict[str, Any] = field(default_factory=dict)

SecurityScheme

SecurityScheme

Bases: Protocol

Protocol for authentication scheme implementations.

Each scheme is a callable that extracts credentials from a Starlette Request. If auto_error is True and credentials are missing, the scheme raises AuthenticationError.

Implementations must provide scheme_name and auto_error attributes, and be callable with a Request argument.

Source code in src/agenticapi/security.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
@runtime_checkable
class SecurityScheme(Protocol):
    """Protocol for authentication scheme implementations.

    Each scheme is a callable that extracts credentials from
    a Starlette ``Request``. If ``auto_error`` is True and
    credentials are missing, the scheme raises ``AuthenticationError``.

    Implementations must provide ``scheme_name`` and ``auto_error``
    attributes, and be callable with a ``Request`` argument.
    """

    scheme_name: str
    auto_error: bool

    async def __call__(self, request: Request) -> AuthCredentials | None:
        """Extract credentials from the request.

        Args:
            request: The incoming Starlette request.

        Returns:
            Extracted credentials, or None if not found and auto_error is False.

        Raises:
            AuthenticationError: If credentials are missing and auto_error is True.
        """
        ...

__call__ async 

__call__(request: Request) -> AuthCredentials | None

Extract credentials from the request.

Parameters:

Name Type Description Default
request Request

The incoming Starlette request.

 required

Returns:

Type Description
AuthCredentials | None

Extracted credentials, or None if not found and auto_error is False.

Raises:

Type Description
AuthenticationError

If credentials are missing and auto_error is True.
Source code in src/agenticapi/security.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
async def __call__(self, request: Request) -> AuthCredentials | None:
    """Extract credentials from the request.

    Args:
        request: The incoming Starlette request.

    Returns:
        Extracted credentials, or None if not found and auto_error is False.

    Raises:
        AuthenticationError: If credentials are missing and auto_error is True.
    """
    ...

APIKeyHeader

APIKeyHeader

Extract an API key from a request header.

Example

scheme = APIKeyHeader(name="X-API-Key") credentials = await scheme(request)

credentials.credentials == "the-key-value"

Parameters:

Name Type Description Default
name str

Header name to read the API key from.

 'X-API-Key'
auto_error bool

If True, raise AuthenticationError when the header is missing.

 True
Source code in src/agenticapi/security.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class APIKeyHeader:
    """Extract an API key from a request header.

    Example:
        scheme = APIKeyHeader(name="X-API-Key")
        credentials = await scheme(request)
        # credentials.credentials == "the-key-value"

    Args:
        name: Header name to read the API key from.
        auto_error: If True, raise AuthenticationError when the header is missing.
    """

    def __init__(self, name: str = "X-API-Key", *, auto_error: bool = True) -> None:
        self.name = name
        self.scheme_name = "apiKeyHeader"
        self.auto_error = auto_error

    async def __call__(self, request: Request) -> AuthCredentials | None:
        """Extract API key from the configured header.

        Args:
            request: The incoming Starlette request.

        Returns:
            AuthCredentials with the API key, or None.

        Raises:
            AuthenticationError: If the header is missing and auto_error is True.
        """
        api_key = request.headers.get(self.name)
        if api_key:
            return AuthCredentials(scheme="apikey", credentials=api_key)
        if self.auto_error:
            raise AuthenticationError(f"Missing {self.name} header")
        return None

__call__ async 

__call__(request: Request) -> AuthCredentials | None

Extract API key from the configured header.

Parameters:

Name Type Description Default
request Request

The incoming Starlette request.

 required

Returns:

Type Description
AuthCredentials | None

AuthCredentials with the API key, or None.

Raises:

Type Description
AuthenticationError

If the header is missing and auto_error is True.
Source code in src/agenticapi/security.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
async def __call__(self, request: Request) -> AuthCredentials | None:
    """Extract API key from the configured header.

    Args:
        request: The incoming Starlette request.

    Returns:
        AuthCredentials with the API key, or None.

    Raises:
        AuthenticationError: If the header is missing and auto_error is True.
    """
    api_key = request.headers.get(self.name)
    if api_key:
        return AuthCredentials(scheme="apikey", credentials=api_key)
    if self.auto_error:
        raise AuthenticationError(f"Missing {self.name} header")
    return None

APIKeyQuery

APIKeyQuery

Extract an API key from a query parameter.

Example

scheme = APIKeyQuery(name="api_key") credentials = await scheme(request) # from ?api_key=value

Parameters:

Name Type Description Default
name str

Query parameter name to read the API key from.

 'api_key'
auto_error bool

If True, raise AuthenticationError when the parameter is missing.

 True
Source code in src/agenticapi/security.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class APIKeyQuery:
    """Extract an API key from a query parameter.

    Example:
        scheme = APIKeyQuery(name="api_key")
        credentials = await scheme(request)  # from ?api_key=value

    Args:
        name: Query parameter name to read the API key from.
        auto_error: If True, raise AuthenticationError when the parameter is missing.
    """

    def __init__(self, name: str = "api_key", *, auto_error: bool = True) -> None:
        self.name = name
        self.scheme_name = "apiKeyQuery"
        self.auto_error = auto_error

    async def __call__(self, request: Request) -> AuthCredentials | None:
        """Extract API key from the configured query parameter.

        Args:
            request: The incoming Starlette request.

        Returns:
            AuthCredentials with the API key, or None.

        Raises:
            AuthenticationError: If the parameter is missing and auto_error is True.
        """
        api_key = request.query_params.get(self.name)
        if api_key:
            return AuthCredentials(scheme="apikey", credentials=api_key)
        if self.auto_error:
            raise AuthenticationError(f"Missing {self.name} query parameter")
        return None

__call__ async 

__call__(request: Request) -> AuthCredentials | None

Extract API key from the configured query parameter.

Parameters:

Name Type Description Default
request Request

The incoming Starlette request.

 required

Returns:

Type Description
AuthCredentials | None

AuthCredentials with the API key, or None.

Raises:

Type Description
AuthenticationError

If the parameter is missing and auto_error is True.
Source code in src/agenticapi/security.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
async def __call__(self, request: Request) -> AuthCredentials | None:
    """Extract API key from the configured query parameter.

    Args:
        request: The incoming Starlette request.

    Returns:
        AuthCredentials with the API key, or None.

    Raises:
        AuthenticationError: If the parameter is missing and auto_error is True.
    """
    api_key = request.query_params.get(self.name)
    if api_key:
        return AuthCredentials(scheme="apikey", credentials=api_key)
    if self.auto_error:
        raise AuthenticationError(f"Missing {self.name} query parameter")
    return None

HTTPBearer

HTTPBearer

Extract a Bearer token from the Authorization header.

Expects the format: Authorization: Bearer <token>

Example

scheme = HTTPBearer() credentials = await scheme(request)

credentials.credentials == "the-jwt-token"

Parameters:

Name Type Description Default
auto_error bool

If True, raise AuthenticationError when the header is missing or malformed.

 True
Source code in src/agenticapi/security.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
class HTTPBearer:
    """Extract a Bearer token from the Authorization header.

    Expects the format: ``Authorization: Bearer <token>``

    Example:
        scheme = HTTPBearer()
        credentials = await scheme(request)
        # credentials.credentials == "the-jwt-token"

    Args:
        auto_error: If True, raise AuthenticationError when the header is missing or malformed.
    """

    def __init__(self, *, auto_error: bool = True) -> None:
        self.scheme_name = "bearer"
        self.auto_error = auto_error

    async def __call__(self, request: Request) -> AuthCredentials | None:
        """Extract Bearer token from the Authorization header.

        Args:
            request: The incoming Starlette request.

        Returns:
            AuthCredentials with the token, or None.

        Raises:
            AuthenticationError: If the header is missing/malformed and auto_error is True.
        """
        authorization = request.headers.get("Authorization")
        if not authorization:
            if self.auto_error:
                raise AuthenticationError("Missing Authorization header")
            return None

        parts = authorization.split(" ", 1)
        if len(parts) != 2 or parts[0].lower() != "bearer":
            if self.auto_error:
                raise AuthenticationError("Invalid Authorization header: expected 'Bearer <token>'")
            return None

        return AuthCredentials(scheme="bearer", credentials=parts[1])

__call__ async 

__call__(request: Request) -> AuthCredentials | None

Extract Bearer token from the Authorization header.

Parameters:

Name Type Description Default
request Request

The incoming Starlette request.

 required

Returns:

Type Description
AuthCredentials | None

AuthCredentials with the token, or None.

Raises:

Type Description
AuthenticationError

If the header is missing/malformed and auto_error is True.
Source code in src/agenticapi/security.py 
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
async def __call__(self, request: Request) -> AuthCredentials | None:
    """Extract Bearer token from the Authorization header.

    Args:
        request: The incoming Starlette request.

    Returns:
        AuthCredentials with the token, or None.

    Raises:
        AuthenticationError: If the header is missing/malformed and auto_error is True.
    """
    authorization = request.headers.get("Authorization")
    if not authorization:
        if self.auto_error:
            raise AuthenticationError("Missing Authorization header")
        return None

    parts = authorization.split(" ", 1)
    if len(parts) != 2 or parts[0].lower() != "bearer":
        if self.auto_error:
            raise AuthenticationError("Invalid Authorization header: expected 'Bearer <token>'")
        return None

    return AuthCredentials(scheme="bearer", credentials=parts[1])

HTTPBasic

HTTPBasic

Extract Basic credentials from the Authorization header.

Expects the format: Authorization: Basic <base64(username:password)>

The extracted credentials string contains the raw password. The username is stored in AuthCredentials.scopes[0] for convenience, but the primary use case is passing both to a verify function.

Example

scheme = HTTPBasic() credentials = await scheme(request)

credentials.credentials == "username:password"

Parameters:

Name Type Description Default
auto_error bool

If True, raise AuthenticationError when the header is missing or malformed.

 True
Source code in src/agenticapi/security.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
class HTTPBasic:
    """Extract Basic credentials from the Authorization header.

    Expects the format: ``Authorization: Basic <base64(username:password)>``

    The extracted ``credentials`` string contains the raw password.
    The ``username`` is stored in ``AuthCredentials.scopes[0]`` for
    convenience, but the primary use case is passing both to a
    verify function.

    Example:
        scheme = HTTPBasic()
        credentials = await scheme(request)
        # credentials.credentials == "username:password"

    Args:
        auto_error: If True, raise AuthenticationError when the header is missing or malformed.
    """

    def __init__(self, *, auto_error: bool = True) -> None:
        self.scheme_name = "basic"
        self.auto_error = auto_error

    async def __call__(self, request: Request) -> AuthCredentials | None:
        """Extract Basic credentials from the Authorization header.

        Args:
            request: The incoming Starlette request.

        Returns:
            AuthCredentials with 'username:password' as credentials, or None.

        Raises:
            AuthenticationError: If the header is missing/malformed and auto_error is True.
        """
        authorization = request.headers.get("Authorization")
        if not authorization:
            if self.auto_error:
                raise AuthenticationError("Missing Authorization header")
            return None

        parts = authorization.split(" ", 1)
        if len(parts) != 2 or parts[0].lower() != "basic":
            if self.auto_error:
                raise AuthenticationError("Invalid Authorization header: expected 'Basic <credentials>'")
            return None

        try:
            decoded = base64.b64decode(parts[1]).decode("utf-8")
        except Exception:
            if self.auto_error:
                raise AuthenticationError("Invalid Basic credentials encoding") from None
            return None

        return AuthCredentials(scheme="basic", credentials=decoded)

__call__ async 

__call__(request: Request) -> AuthCredentials | None

Extract Basic credentials from the Authorization header.

Parameters:

Name Type Description Default
request Request

The incoming Starlette request.

 required

Returns:

Type Description
AuthCredentials | None

AuthCredentials with 'username:password' as credentials, or None.

Raises:

Type Description
AuthenticationError

If the header is missing/malformed and auto_error is True.
Source code in src/agenticapi/security.py 
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
async def __call__(self, request: Request) -> AuthCredentials | None:
    """Extract Basic credentials from the Authorization header.

    Args:
        request: The incoming Starlette request.

    Returns:
        AuthCredentials with 'username:password' as credentials, or None.

    Raises:
        AuthenticationError: If the header is missing/malformed and auto_error is True.
    """
    authorization = request.headers.get("Authorization")
    if not authorization:
        if self.auto_error:
            raise AuthenticationError("Missing Authorization header")
        return None

    parts = authorization.split(" ", 1)
    if len(parts) != 2 or parts[0].lower() != "basic":
        if self.auto_error:
            raise AuthenticationError("Invalid Authorization header: expected 'Basic <credentials>'")
        return None

    try:
        decoded = base64.b64decode(parts[1]).decode("utf-8")
    except Exception:
        if self.auto_error:
            raise AuthenticationError("Invalid Basic credentials encoding") from None
        return None

    return AuthCredentials(scheme="basic", credentials=decoded)

Authenticator

Authenticator dataclass

Combines a security scheme with a verification function.

The scheme extracts raw credentials from the request. The verify function validates those credentials and returns an AuthUser (or None if invalid).

Used as the auth= parameter on endpoint decorators and the AgenticApp constructor.

Example

api_key = APIKeyHeader(name="X-API-Key")

async def verify(creds: AuthCredentials) -> AuthUser | None: if creds.credentials == "secret-key": return AuthUser(user_id="u1", username="alice") return None

auth = Authenticator(scheme=api_key, verify=verify)

@app.agent_endpoint(name="orders", auth=auth) async def orders_agent(intent, context): print(context.user_id) # "u1"

Attributes:

Name Type Description
scheme SecurityScheme

The security scheme that extracts credentials.
verify Callable[[AuthCredentials], Awaitable[AuthUser | None]]

Async function that validates credentials and returns an AuthUser.
Source code in src/agenticapi/security.py 
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
@dataclass(frozen=True, slots=True)
class Authenticator:
    """Combines a security scheme with a verification function.

    The scheme extracts raw credentials from the request.
    The verify function validates those credentials and returns
    an ``AuthUser`` (or None if invalid).

    Used as the ``auth=`` parameter on endpoint decorators
    and the ``AgenticApp`` constructor.

    Example:
        api_key = APIKeyHeader(name="X-API-Key")

        async def verify(creds: AuthCredentials) -> AuthUser | None:
            if creds.credentials == "secret-key":
                return AuthUser(user_id="u1", username="alice")
            return None

        auth = Authenticator(scheme=api_key, verify=verify)

        @app.agent_endpoint(name="orders", auth=auth)
        async def orders_agent(intent, context):
            print(context.user_id)  # "u1"

    Attributes:
        scheme: The security scheme that extracts credentials.
        verify: Async function that validates credentials and returns an AuthUser.
    """

    scheme: SecurityScheme
    verify: Callable[[AuthCredentials], Awaitable[AuthUser | None]]