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

class ForgotPasswordController(BaseController): (source)

View In Hierarchy

Handle the built-in password-reset request endpoints.

Static Method _private Mark a response as private and prevent reset URL referrers.
Async Method _form Render the reset form without exposing password values.
Async Method _sendConfirmation Notify the account owner after the password reset commits.
Async Method _sendLink Issue and deliver a reset link after the response.
Async Method index Render the forgot-password page.
Async Method resetPassword Reset the password without flashing credentials or tokens.
Async Method sendResetLinkEmail Queue a password-reset message without revealing account existence.
Async Method showResetForm Display a reset form for an unconsumed link.
Constant SENT_MESSAGE Confirmation shown after a password-reset request, regardless of whether the account exists.

Mark a response as private and prevent reset URL referrers.

Parameters
result:orionis.http.ResponseResponse whose security headers are updated.
Returns
orionis.http.ResponseThe same response with privacy and indexing headers applied.
async def _form(self, email: str, token: str, *, valid: bool, errors: dict[str, str] | ValidationException | None = None) -> HTMLResponse: (source)

Render the reset form without exposing password values.

Parameters
email:strEmail value retained only when the link is valid.
token:strReset token retained only when the link is valid.
valid:boolWhether the reset link passed token validation.
errors:dict[str, str] | ValidationException | None, optionalValidation errors to display on the form.
Returns
orionis.http.HTMLResponsePrivate reset form response with optional validation errors.
async def _sendConfirmation(self, email: str): (source)

Notify the account owner after the password reset commits.

Parameters
email:strAccount email address that receives the notification.
Returns
NoneCompletes after the reset notification is sent.
async def _sendLink(self, email: str, base_url: str, broker: PasswordBroker): (source)

Issue and deliver a reset link after the response.

Parameters
email:strEmail address submitted for password recovery.
base_url:strApplication base URL used to construct the link.
broker:orionis.auth.passwords.broker.PasswordBrokerService that issues the reset token and loads the account.
Returns
NoneCompletes after delivery or when no matching account is found.
async def index(self) -> HTMLResponse: (source)

Render the forgot-password page.

Returns
orionis.http.HTMLResponseRendered forgot-password page response.
async def resetPassword(self, request: Request, broker: PasswordBroker) -> HttpResponse: (source)

Reset the password without flashing credentials or tokens.

Parameters
request:orionis.http.RequestCurrent HTTP request containing the reset form payload.
broker:orionis.auth.passwords.broker.PasswordBrokerService that validates and consumes the reset token.
Returns
orionis.http.ResponseReset form response for invalid input, or a private login redirect after a successful reset.
async def sendResetLinkEmail(self, payload: ForgotPasswordSchema, request: Request, broker: PasswordBroker) -> HttpResponse: (source)

Queue a password-reset message without revealing account existence.

Parameters
payload:orionis.http.default.schemas.forgot_password.ForgotPasswordSchemaValidated email address submitted by the requester.
request:orionis.http.RequestCurrent HTTP request used to build the reset URL.
broker:orionis.auth.passwords.broker.PasswordBrokerService that issues and validates reset tokens.
Returns
orionis.http.ResponsePrivate redirect response returned before account lookup.
async def showResetForm(self, request: Request, broker: PasswordBroker) -> HTMLResponse: (source)

Display a reset form for an unconsumed link.

Parameters
request:orionis.http.RequestCurrent HTTP request containing the email and token query values.
broker:orionis.auth.passwords.broker.PasswordBrokerService that validates the reset token.
Returns
orionis.http.HTMLResponseReset form response with the link validity state.
SENT_MESSAGE: str = (source)

Confirmation shown after a password-reset request, regardless of whether the account exists.

Value
'If an account matches that email, you will receive a password reset link.'