Account | /src/services/account.ts | appwrite@12.1.0

class Account

import { Account } from "https://deno.land/x/appwrite@12.1.0/src/services/account.ts";

Methods

create<Preferences extends Models.Preferences>(

userId: string,

email: string,

password: string,

name?: string,

): Promise<Models.User<Preferences>>

Create account

Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the /account/verfication route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new account session.

createAnonymousSession(): Promise<Models.Session>

Create anonymous session

Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its email and password or create an OAuth2 session.

createEmailPasswordSession(email: string, password: string): Promise<Models.Session>

Create email password session

Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

createEmailToken(

userId: string,

email: string,

phrase?: boolean,

): Promise<Models.Token>

Create email token (OTP)

Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the POST /v1/account/sessions/token endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

createJWT(): Promise<Models.Jwt>

Create JWT

Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.

createMagicURLToken(

userId: string,

email: string,

url?: string,

phrase?: boolean,

): Promise<Models.Token>

Create magic URL token

Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the POST /v1/account/sessions/token endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>

Create Authenticator

Add an authenticator app to be used as an MFA factor. Verify the authenticator using the verify authenticator method.

createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>

Create MFA Challenge

Begin the process of MFA verification after sign-in. Finish the flow with updateMfaChallenge method.

createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>

Create MFA Recovery Codes

Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in createMfaChallenge method.

createOAuth2Token(

provider: OAuthProvider,

success?: string,

failure?: string,

scopes?: string[],

): Promise<string>

Create OAuth2 token

Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.

If authentication succeeds, userId and secret of a token will be appended to the success URL as query parameters. These can be used to create a new session using the Create session endpoint.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

createPhoneToken(userId: string, phone: string): Promise<Models.Token>

Create phone token

Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the POST /v1/account/sessions/token endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.

A user is limited to 10 active sessions at a time by default. Learn more about session limits.

createPhoneVerification(): Promise<Models.Token>

Create phone verification

Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the accountUpdatePhone endpoint. Learn more about how to complete the verification process. The verification code sent to the user's phone number is valid for 15 minutes.

createRecovery(email: string, url: string): Promise<Models.Token>

Create password recovery

Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the PUT /account/recovery endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.

createSession(userId: string, secret: string): Promise<Models.Session>

Create session

Use this endpoint to create a session from token. Provide the userId and secret parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.

createVerification(url: string): Promise<Models.Token>

Create email verification

Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the userId and secret arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the userId and secret parameters. Learn more about how to complete the verification process. The verification link sent to the user's email address is valid for 7 days.

Please note that in order to avoid a Redirect Attack, the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.

deleteIdentity(identityId: string): Promise<Response>

Delete identity

Delete an identity by its unique ID.

deleteMfaAuthenticator(type: AuthenticatorType): Promise<Response>

Delete Authenticator

Delete an authenticator for a user by ID.

deleteSession(sessionId: string): Promise<Response>

Delete session

Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use Delete Sessions instead.

deleteSessions(): Promise<Response>

Delete sessions

Delete all sessions from the user account and remove any sessions cookies from the end client.

get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>

Get account

Get the currently logged in user.

getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>

Get MFA Recovery Codes

Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using createMfaRecoveryCodes method. An OTP challenge is required to read recovery codes.

getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>

Get account preferences

Get the preferences as a key-value object for the currently logged in user.

getSession(sessionId: string): Promise<Models.Session>

Get session

Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.

listIdentities(queries?: string[]): Promise<Models.IdentityList>

List Identities

Get the list of identities for the currently logged in user.

listLogs(queries?: string[]): Promise<Models.LogList>

List logs

Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.

listMfaFactors(): Promise<Models.MfaFactors>

List Factors

List the factors available on the account to be used as a MFA challange.

listSessions(): Promise<Models.SessionList>

List sessions

Get the list of active sessions across different devices for the currently logged in user.

updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>

Update email

Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request. This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.

updateMagicURLSession(userId: string, secret: string): Promise<Models.Session>

Update magic URL session

updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>

Update MFA

Enable or disable MFA on an account.

updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>

Verify Authenticator

Verify an authenticator app after adding it using the add authenticator method.

updateMfaChallenge(challengeId: string, otp: string): Promise<Response>

Create MFA Challenge (confirmation)

Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use createMfaChallenge method.

updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>

Regenerate MFA Recovery Codes

Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using createMfaRecoveryCodes method. An OTP challenge is required to regenreate recovery codes.

updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.User<Preferences>>

Update name

Update currently logged in user account name.

updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>

Update password

Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.

updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.User<Preferences>>

Update phone

Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the POST /account/verification/phone endpoint to send a confirmation SMS.

updatePhoneSession(userId: string, secret: string): Promise<Models.Session>

Update phone session

updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>

Update phone verification (confirmation)

Use this endpoint to complete the user phone verification process. Use the userId and secret that were sent to your user's phone number to verify the user email ownership. If confirmed this route will return a 200 status code.

updatePrefs<Preferences extends Models.Preferences>(prefs: object): Promise<Models.User<Preferences>>

Update preferences

Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.

updateRecovery(

userId: string,

secret: string,

password: string,

): Promise<Models.Token>

Create password recovery (confirmation)

Use this endpoint to complete the user account password reset. Both the userId and secret arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the POST /account/recovery endpoint.

Please note that in order to avoid a Redirect Attack the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.

updateSession(sessionId: string): Promise<Models.Session>

Update session

Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.

updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>

Update status

Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.

updateVerification(userId: string, secret: string): Promise<Models.Token>

Create email verification (confirmation)

Use this endpoint to complete the user email verification process. Use both the userId and secret parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.

Constructors

Methods