orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController

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)

Undocumented

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`	Undocumented

def _private(result: HttpResponse) -> HttpResponse: (source) ¶

Mark a response as private and prevent reset URL referrers.

Parameters
result:`HttpResponse`	Response whose security headers are updated.

Returns
`HttpResponse`	The 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:`str`	Email value retained only when the link is valid.
token:`str`	Reset token retained only when the link is valid.
valid:`bool`	Whether the reset link passed token validation.
errors:`dict[str, str] \| ValidationException \| None, optional`	Validation errors to display on the form.

Returns
`HTMLResponse`	Private 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:`str`	Account email address that receives the notification.

Returns
`None`	Completes 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:`str`	Email address submitted for password recovery.
base_url:`str`	Application base URL used to construct the link.
broker:`PasswordBroker`	Service that issues the reset token and loads the account.

Returns
`None`	Completes after delivery or when no matching account is found.

async def index(self) -> HTMLResponse: (source) ¶

Render the forgot-password page.

Returns
`HTMLResponse`	Rendered forgot-password page response.

async def resetPassword(self, request: Request, broker: PasswordBroker) -> HttpResponse: (source) ¶

Reset the password without flashing credentials or tokens.

Parameters
request:`Request`	Current HTTP request containing the reset form payload.
broker:`PasswordBroker`	Service that validates and consumes the reset token.

Returns
`HttpResponse`	Reset 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:`ForgotPasswordSchema`	Validated email address submitted by the requester.
request:`Request`	Current HTTP request used to build the reset URL.
broker:`PasswordBroker`	Service that issues and validates reset tokens.

Returns
`HttpResponse`	Private 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:`Request`	Current HTTP request containing the email and token query values.
broker:`PasswordBroker`	Service that validates the reset token.

Returns
`HTMLResponse`	Reset form response with the link validity state.

Undocumented

Value

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