Signup
Provides coroutine-based methods for account registration and initial authentication within the Norman authentication system.
The Signup class supports multiple registration flows including default signups, API key-based creation, email-based signup, and password-based signup.
signup_and_generate_key(signup_request) async
Coroutine
Register a new account and generate an API key for authentication.
Parameters
signup_request (
SignupKeyRequest) — Request object containing account details for key-based signup.
Response Structure
response (
Account) — The created account metadata returned upon successful registration.
⚠️ Important: Store the API key securely. API keys cannot be regenerated — losing it requires creating a new one.
signup_and_generate_key(signup_request) async
Coroutine
Register a new account and generate an API key for authentication.
Parameters
signup_request (
SignupKeyRequest) — Request object containing account details for key-based signup.
Response Structure
response (
Account) — The created account metadata returned upon successful registration.
⚠️ Important: Store the API key securely. API keys cannot be regenerated — losing it requires creating a new one.
signup_default() async
Coroutine
Create a default account and receive a LoginResponse for immediate authentication.
This method is typically used for creating a temporary or anonymous account session.
Parameters
(none) — This method does not require input parameters.
Response Structure
response (
LoginResponse) — The authenticated session returned after successful signup.
signup_with_email(signup_request) async
Coroutine
Register a new account using an email-based signup flow.
Parameters
signup_request (
SignupEmailRequest) — Request object containing the email and optional display name.
Response Structure
response (
Account) — The created account metadata returned upon signup.
signup_with_password(signup_request) async
Coroutine
Register a new account using a username and password.
Parameters
signup_request (
SignupPasswordRequest) — Request object containing credentials for password-based signup.
Response Structure
response (
Account) — The created account object returned upon successful signup.