Register
Provides coroutine-based registration and authentication-factor management for the Norman authentication service.
The Register class handles registration flows including password creation, email registration and verification, API-key generation, and retrieval of available authentication factors.
Constructor- init()
Initializes the Register service and creates an internal HttpClient instance used to communicate with the Norman authentication backend. Because this class is implemented as a singleton, the same HTTP client instance is reused across the application, improving connection reuse and reducing overhead.
Constructor- init()
Initializes the Register service and creates an internal HttpClient instance used to communicate with the Norman authentication backend. Because this class is implemented as a singleton, the same HTTP client instance is reused across the application, improving connection reuse and reducing overhead.
generate_api_key(token, register_key_request) async
Coroutine
Generate a new API key for an existing account.
Parameters
token (
Sensitive[str]) - Authentication token authorizing the request.register_key_request (
RegisterAuthFactorRequest) - Request object specifying the account and key-generation parameters.
Returns
response (
str) - Newly generated API key as a sensitive string value.
⚠️ Important: Store the API key securely. Keys cannot be regenerated - losing it requires creating a new one.
get_authentication_factors(token, account_id) async
Coroutine
Retrieve all authentication factors currently associated with a given account.
Parameters
token (
Sensitive[str]) - Authentication token authorizing the request.account_id (
str) - Unique identifier of the account whose authentication factors should be retrieved.
Returns
response (
AccountAuthenticationFactors) - Object describing which authentication factors (email, password, key, etc.) are registered for the account.
register_email(token, register_email_request) async
Coroutine
Register an email authentication factor for an account.
Parameters
token (
Sensitive[str]) - Authentication token authorizing the request.register_email_request (
RegisterEmailRequest) - Request object containing the email registration details.
Returns
response (
None) - No response body. An email verification code is sent to the provided address.
register_password(token, register_password_request) async
Coroutine
Register or update a password authentication factor for an account.
Parameters
token (
Sensitive[str]) - Authentication token authorizing the request.register_password_request (
RegisterPasswordRequest) - Request object containing the password registration payload.
Returns
response (
None) - No response body. A successful status indicates password registration succeeded.
resend_email_otp(token, resend_email_verification_code_request) async
Coroutine
Resend a verification code to the registered email address.
Parameters
token (
Sensitive[str]) - Authentication token authorizing the request.resend_email_verification_code_request (
ResendEmailVerificationCodeRequest) - Request payload containing the target email and account ID.
Returns
response (
None) - No response body. A new OTP is delivered to the provided email.