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 RegisterController(BaseController): (source)

View In Hierarchy

Handle the built-in account-registration endpoints.

Async Method __resolveUser 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 sendVerificationEmail Send a verification email to the newly registered user.
Async Method verifyEmail Activate the account addressed by a verification link.
Constant REGISTER_REDIRECT_PATH /login.
Constant REGISTER_VIEW_NAME auth.register.
Constant VERIFY_PARAM_NAME id.
Constant VERIFY_VIEW_NAME auth.verify-email.
async def __resolveUser(self, encrypted_id: str | None) -> User | None: (source)

Resolve the account referenced by an encrypted verification link.

Parameters
encrypted_id:str | NoneEncrypted identifier extracted from the verification link.
Returns
app.models.user.User | NoneMatching user, or None when the link is absent, forged or points to an account that no longer exists.
async def index(self) -> HttpResponse: (source)

Return the registration page response.

Returns
orionis.http.ResponseRendered response for the registration page.
async def register(self, payload: RegisterSchema, request: Request) -> HttpResponse: (source)

Handle the registration form submission.

Parameters
payload:orionis.http.default.schemas.register.RegisterSchemaIncoming request carrying the submitted account data.
request:orionis.http.RequestCurrent request and its trusted execution context.
Returns
orionis.http.ResponseRedirect after committing the account, or render generic form errors.
Raises
asyncio.CancelledErrorIf the request is cancelled, after the transaction rolls back.
async def sendVerificationEmail(self, base_url: str, user: User) -> MailResult: (source)

Send a verification email to the newly registered user.

Parameters
base_url:strThe base URL of the application, used to construct the verification link.
user:app.models.user.UserThe user to whom the verification email will be sent.
Returns
orionis.mail.entities.MailResultThe result of the email sending operation.
async def verifyEmail(self, request: Request) -> HttpResponse: (source)

Activate the account addressed by a verification link.

Parameters
request:orionis.http.RequestIncoming request carrying the encrypted identifier in its query string.
Returns
orionis.http.ResponseRendered outcome page reporting the verification state.
Raises
RuntimeErrorIf the model refuses to persist the verification update.
REGISTER_REDIRECT_PATH: str = (source)

/login.

Value
'/login'
REGISTER_VIEW_NAME: str = (source)

auth.register.

Value
'auth.register'
VERIFY_PARAM_NAME: str = (source)

id.

Value
'id'
VERIFY_VIEW_NAME: str = (source)

auth.verify-email.

Value
'auth.verify-email'