ORIONIS API REFERENCE

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.

Explore modules View classes

orionis.auth.entities.GuardResult

class documentation

class GuardResult: (source)

View In Hierarchy

Carry what a guard learned about the incoming request.

Instance Variable abilities Abilities restricting the presented credential, or None when the credential keeps the full authorization of the identity.
Instance Variable credential_id Identifier of the credential used, when the guard works with revocable credentials such as personal access tokens.
Instance Variable guard Name of the guard that resolved the identity.
Instance Variable identity Identity resolved from the presented credential.
abilities: frozenset[str] | None = (source)

Abilities restricting the presented credential, or None when the credential keeps the full authorization of the identity.

credential_id: object | None = (source)

Identifier of the credential used, when the guard works with revocable credentials such as personal access tokens.

guard: str = (source)

Name of the guard that resolved the identity.

identity: IAuthenticatable = (source)

Identity resolved from the presented credential.