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.

class documentation

Issue hashed credentials and consume them with the password atomically.

Method __init__ Initialize the broker with the configured identity and services.
Async Method _creationConflict Check an insert conflict without replacing its original failure.
Method _query Build an identity query on the reset store's exact connection.
Method _records Build a query for the account's password-reset record.
Async Method _resolve Resolve a current reset token to its identity.
Async Method issue Issue a reset token when the account's cooldown has elapsed.
Async Method reset Consume a reset token and atomically replace the password.
Async Method valid Validate a reset link without consuming its token.
Instance Variable db Query builder used to access the reset table.
Instance Variable hashing Password hasher used to fingerprint and replace passwords.
Instance Variable model Model selected for generation or persistence.
Instance Variable settings Resolve the configured identity once for this broker.
Instance Variable tokens Tokens produced by AccessTokenRepository.
def __init__(self, app: IApplication, db: IQueryBuilder, hashing: IHashManager): (source)

Initialize the broker with the configured identity and services.

Parameters
app:orionis.IApplicationApplication providing password-reset configuration.
db:orionis.orm.contracts.query_builder.IQueryBuilderQuery builder used to access the reset table.
hashing:orionis.hashing.contracts.IHashManagerPassword hasher used to fingerprint and replace passwords.
Returns
NoneNo return value.
async def _creationConflict(self, email: str) -> bool: (source)

Check an insert conflict without replacing its original failure.

Parameters
email:strAddress whose reset record may have been inserted concurrently.
Returns
boolWhether the recovery lookup confirms that a reset record now exists.
def _query(self) -> _orm.ModelQueryBuilder: (source)

Build an identity query on the reset store's exact connection.

Returns
orionis.orm.query.ModelQueryBuilderFresh scoped model query retaining the injected gateway's connection.
def _records(self, email: str) -> IRawQueryBuilder: (source)

Build a query for the account's password-reset record.

Parameters
email:strNormalized email address identifying the account.
Returns
orionis.orm.contracts.raw_builder.IRawQueryBuilderFresh query scoped to the configured reset table and email.
async def _resolve(self, email: str, token: str) -> _orm.Model | None: (source)

Resolve a current reset token to its identity.

Parameters
email:strNormalized email address associated with the token.
token:strPlain reset token supplied by the caller.
Returns
orionis.orm.Model | NoneMatching identity when the token is valid and current, otherwise None.
async def issue(self, email: str) -> tuple[_orm.Model, str] | None: (source)

Issue a reset token when the account's cooldown has elapsed.

Parameters
email:strEmail address associated with the identity.
Returns
tuple[orionis.orm.Model, str] | NoneThe identity and plain token when issued, or None when the identity is unknown or a recent token is still in its cooldown.
async def reset(self, email: str, token: str, password: str) -> _orm.Model | None: (source)

Consume a reset token and atomically replace the password.

Parameters
email:strEmail address associated with the token.
token:strPlain reset token supplied by the caller.
password:strNew plaintext password to hash and store.
Returns
orionis.orm.Model | NoneUpdated identity when the reset succeeds, or None when the token is invalid, stale, expired, or already consumed.
async def valid(self, email: str, token: str) -> bool: (source)

Validate a reset link without consuming its token.

Parameters
email:strEmail address associated with the token.
token:strPlain reset token supplied by the caller.
Returns
boolTrue when the token resolves to the current identity; otherwise, False.

Query builder used to access the reset table.

Password hasher used to fingerprint and replace passwords.

Model selected for generation or persistence.

settings = (source)

Resolve the configured identity once for this broker.

Tokens produced by AccessTokenRepository.