@spec create(String.t() | nil, String.t(), String.t(), String.t() | nil) ::
  {:ok, map()} | {:error, any()}

Create a new account.

Parameters

• user_id — unique ID; auto-generated when nil
• email (required)
• password (required)
• name (optional)

@spec create_anonymous_session() :: {:ok, map()} | {:error, any()}

Create an anonymous session.

@spec create_email_password_session(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Create a session using email and password.

@spec create_email_token(String.t(), String.t(), boolean() | nil) ::
  {:ok, map()} | {:error, any()}

Create an email token for passwordless / magic-link authentication.

@spec create_jwt(integer() | nil) :: {:ok, map()} | {:error, any()}

Create a JWT for the current user.

Parameters

• duration (optional) — seconds before expiry; default 900, max 3600

@spec create_magic_url_token(
  String.t(),
  String.t(),
  String.t() | nil,
  boolean() | nil
) ::
  {:ok, map()} | {:error, any()}

Create a magic URL token for passwordless authentication.

@spec create_mfa_authenticator(String.t()) :: {:ok, map()} | {:error, any()}

Create a new MFA authenticator of the given type (e.g. "totp").

@spec create_mfa_challenge(String.t()) :: {:ok, map()} | {:error, any()}

Create an MFA challenge for a given factor.

factor must be a valid Appwrite.Consts.AuthenticationFactor value.

@spec create_mfa_recovery_codes() :: {:ok, map()} | {:error, any()}

Generate new MFA recovery codes.

@spec create_oauth2_session(
  String.t(),
  String.t() | nil,
  String.t() | nil,
  [String.t()] | nil
) :: {:ok, String.t()} | {:error, any()}

Build the OAuth2 authorization URL for the given provider.

Returns the URL as a string — the caller should redirect the user to it.

@spec create_oauth2_token(
  String.t(),
  String.t() | nil,
  String.t() | nil,
  [String.t()] | nil
) :: {:ok, String.t()} | {:error, any()}

Build the OAuth2 token URL (redirects user to provider, then creates a session token).

@spec create_phone_token(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Create a phone token for SMS-based OTP authentication.

@spec create_phone_verification() :: {:ok, map()} | {:error, any()}

Send a phone verification SMS to the current user's registered phone number.

@spec create_push_target(String.t(), String.t(), String.t() | nil) ::
  {:ok, map()} | {:error, any()}

Register a push notification target (device token).

@spec create_recovery(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Send a password recovery email.

Parameters

• email (required) — the user's email address
• url (required) — redirect URL embedded in the recovery email

@spec create_session(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Create a session from a short-lived token (userId + secret).

@spec create_verification(String.t()) :: {:ok, map()} | {:error, any()}

Send an email verification link to the current user.

@spec delete_identity(String.t()) :: {:ok, map()} | {:error, any()}

Delete an identity by its unique ID.

@spec delete_mfa_authenticator(String.t()) :: {:ok, map()} | {:error, any()}

Delete an MFA authenticator.

@spec delete_push_target(String.t()) :: {:ok, map()} | {:error, any()}

Delete a push notification target.

@spec delete_session(map(), String.t()) :: {:ok, map()} | {:error, any()}

Delete a session by ID. Use "current" to log out of the active session.

@spec delete_sessions() :: {:ok, map()} | {:error, any()}

Delete all active sessions (log out from all devices).

@spec get() :: {:ok, map()} | {:error, any()}

Get the currently logged-in user.

@spec get_mfa_recovery_codes() :: {:ok, map()} | {:error, any()}

Get the MFA recovery codes for the current account.

@spec get_prefs() :: {:ok, map()} | {:error, any()}

Get the current user's preferences object.

@spec get_session(map(), String.t()) :: {:ok, map()} | {:error, any()}

Get a session by ID. Use "current" for the active session.

@spec list_identities([String.t()] | nil, boolean() | nil) ::
  {:ok, map()} | {:error, any()}

List identities for the currently logged-in user.

Parameters

• queries (optional)
• total (optional) — when false, skips total count calculation

@spec list_logs([String.t()] | nil, boolean() | nil) :: {:ok, map()} | {:error, any()}

List activity logs for the currently logged-in user.

Parameters

• queries (optional)
• total (optional) — when false, skips total count calculation

@spec list_mfa_factors() :: {:ok, map()} | {:error, any()}

List all available MFA factors on the current account.

@spec list_sessions() :: {:ok, map()} | {:error, any()}

List all active sessions for the current user.

@spec update_email(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update the currently logged-in user's email address.

Requires the current password for confirmation.

@spec update_magic_url_session(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Complete a magic-URL session (supply userId + secret from the email link).

@spec update_mfa(boolean()) :: {:ok, map()} | {:error, any()}

Enable or disable MFA on the current account.

@spec update_mfa_authenticator(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Verify and activate an MFA authenticator by providing its one-time password.

@spec update_mfa_challenge(String.t(), String.t()) ::
  {:ok, Appwrite.Types.Session.t()} | {:error, any()}

Complete an MFA challenge by providing the one-time password.

Returns the created Session on success.

@spec update_mfa_recovery_codes() :: {:ok, map()} | {:error, any()}

Regenerate MFA recovery codes (requires a completed OTP challenge).

@spec update_name(String.t()) :: {:ok, map()} | {:error, any()}

Update the current user's display name.

@spec update_password(String.t(), String.t() | nil) :: {:ok, map()} | {:error, any()}

Update the current user's password. old_password is required unless the account has no password.

@spec update_phone(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update the current user's phone number. Requires current password.

@spec update_phone_session(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Complete a phone OTP session (supply userId + secret from the SMS).

@spec update_phone_verification(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Confirm phone verification using the userId and secret from the verification SMS.

@spec update_prefs(map()) :: {:ok, map()} | {:error, any()}

Replace the current user's preferences object.

@spec update_push_target(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Update a push notification target's device token.

@spec update_recovery(String.t(), String.t(), String.t()) ::
  {:ok, Appwrite.Types.Token.t()} | {:error, any()}

Complete the password reset flow.

Call this with the userId and secret query parameters from the recovery email link, plus the user's chosen new password.

Parameters

• user_id (required)
• secret (required) — the reset token from the email link
• password (required) — the new password (8–256 chars)

@spec update_session(map(), String.t()) :: {:ok, map()} | {:error, any()}

Extend or update an existing session.

@spec update_status() :: {:ok, map()} | {:error, any()}

Block the current account (sets status to false).

@spec update_verification(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Confirm email verification using the userId and secret from the verification link.