Login
login_default(account_id) async
Coroutine
Perform a default login for a specific account ID. works only for account without any auth factors.
Parameters
account_id (
str) — The unique identifier of the account to log into.
Response Structure
response (
LoginResponse) — The authenticated session object, containing token and account details.
login_email_otp(email) async
Coroutine
Initiate an email-based One-Time Password (OTP) login flow.
Sends an OTP code to the provided email address for verification.
Parameters
email (
str) — The user’s email address to which the OTP will be sent.
Response Structure
response (
None) — No response body. A verification code is sent to the email.
login_email_otp(email) async
Coroutine
Initiate an email-based One-Time Password (OTP) login flow.
Sends an OTP code to the provided email address for verification.
Parameters
email (
str) — The user’s email address to which the OTP will be sent.
Response Structure
response (
None) — No response body. A verification code is sent to the email.
login_password_account_id(login_request) async
Coroutine
Authenticate with an account ID and password.
Parameters
Response Structure
response (
LoginResponse) — Contains authentication token, session data, and account metadata.
login_password_email(login_request) async
Coroutine
Authenticate with an email address and password.
Parameters
login_request (
EmailPasswordLoginRequest) — Request object containing the email and password.
Response Structure
response (
LoginResponse) — Contains token and authenticated account details.
login_password_name(login_request) async
Coroutine
Authenticate with an account name and password.
Parameters
login_request (
NamePasswordLoginRequest) — Request object containing the account name and password.
Response Structure
response (
LoginResponse) — Login result including token, expiration, and account details.
login_with_key(api_key_login_request) async
Coroutine
Authenticate using an API key.
Parameters
api_key_login_request (
ApiKeyLoginRequest) — Request object containing the API key credentials.
Response Structure
response (
LoginResponse) — The login response containing the authentication token and account metadata.
verify_email_otp(email, code) async
Coroutine
Verify a previously sent email OTP and complete the login process.
Parameters
email (
str) — The email address used during OTP initiation.code (
str) — The one-time password code received via email.
Response Structure
response (
LoginResponse) — Contains authentication token and account details upon successful verification.