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 | _creation |
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. |
Initialize the broker with the configured identity and services.
| Parameters | |
app:orionis.IApplication | Application providing password-reset configuration. |
db:orionis.orm.contracts.query_builder.IQueryBuilder | Query builder used to access the reset table. |
hashing:orionis.hashing.contracts.IHashManager | Password hasher used to fingerprint and replace passwords. |
| Returns | |
None | No return value. |
Build an identity query on the reset store's exact connection.
| Returns | |
orionis.orm.query.ModelQueryBuilder | Fresh scoped model query retaining the injected gateway's connection. |
Build a query for the account's password-reset record.
| Parameters | |
email:str | Normalized email address identifying the account. |
| Returns | |
orionis.orm.contracts.raw_builder.IRawQueryBuilder | Fresh query scoped to the configured reset table and email. |
Issue a reset token when the account's cooldown has elapsed.
| Parameters | |
email:str | Email address associated with the identity. |
| Returns | |
tuple[orionis.orm.Model, str] | None | The identity and plain token when issued, or None when the identity is unknown or a recent token is still in its cooldown. |
Consume a reset token and atomically replace the password.
| Parameters | |
email:str | Email address associated with the token. |
token:str | Plain reset token supplied by the caller. |
password:str | New plaintext password to hash and store. |
| Returns | |
orionis.orm.Model | None | Updated identity when the reset succeeds, or None when the token is invalid, stale, expired, or already consumed. |