orionis.auth.contracts.IGuard

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class IGuard(ABC): (source)

Define how an authenticated identity is extracted from a request.

A guard answers exactly one question: given the current HTTP context, is there an authenticated identity and which one is it?

Async Method	`resolve`	Resolve the identity backing the incoming request.
Class Variable	`__slots__`	Undocumented
Property	`name`	Return the configuration name of this guard.

@abstractmethod

async def resolve(self, request: Request) -> GuardResult | None: (source) ¶

Resolve the identity backing the incoming request.

Parameters
request:`Request`	Incoming HTTP request.

Returns
`GuardResult \| None`	Resolved identity together with the abilities of the presented credential, or `None` when the request is anonymous.

overridden in orionis.auth.contracts.ISessionGuard

Undocumented

@property
@abstractmethod

Return the configuration name of this guard.

Returns
`str`	Name used by the configuration and stored in the context.