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 RegisterController(BaseController): (source)
Handle the built-in account-registration endpoints.
| Async Method | __resolve |
Resolve the account referenced by an encrypted verification link. |
| Async Method | index |
Return the registration page response. |
| Async Method | register |
Handle the registration form submission. |
| Async Method | send |
Send a verification email to the newly registered user. |
| Async Method | verify |
Activate the account addressed by a verification link. |
| Constant | REGISTER |
/login. |
| Constant | REGISTER |
auth.register. |
| Constant | VERIFY |
id. |
| Constant | VERIFY |
auth.verify-email. |
Resolve the account referenced by an encrypted verification link.
| Parameters | |
encryptedstr | None | Encrypted identifier extracted from the verification link. |
| Returns | |
app.models.user.User | None | Matching user, or None when the link is absent, forged or points to an account that no longer exists. |
Return the registration page response.
| Returns | |
orionis.http.Response | Rendered response for the registration page. |
Handle the registration form submission.
| Parameters | |
payload:orionis.http.default.schemas.register.RegisterSchema | Incoming request carrying the submitted account data. |
request:orionis.http.Request | Current request and its trusted execution context. |
| Returns | |
orionis.http.Response | Redirect after committing the account, or render generic form errors. |
| Raises | |
asyncio.CancelledError | If the request is cancelled, after the transaction rolls back. |
Send a verification email to the newly registered user.
| Parameters | |
basestr | The base URL of the application, used to construct the verification link. |
user:app.models.user.User | The user to whom the verification email will be sent. |
| Returns | |
orionis.mail.entities.MailResult | The result of the email sending operation. |
Activate the account addressed by a verification link.
| Parameters | |
request:orionis.http.Request | Incoming request carrying the encrypted identifier in its query string. |
| Returns | |
orionis.http.Response | Rendered outcome page reporting the verification state. |
| Raises | |
RuntimeError | If the model refuses to persist the verification update. |