Account Service

GET https://cloud.appwrite.io/v1/account

** Get the currently logged in user. **

POST https://cloud.appwrite.io/v1/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. **

Parameters

Field Name	Type	Description
userId	string	User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
email	string	User email.
password	string	New user password. Must be between 8 and 256 chars.
name	string	User name. Max length: 128 chars.

PATCH https://cloud.appwrite.io/v1/account/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. **

Parameters

Field Name	Type	Description	Default
email	string	User email.
password	string	User password. Must be at least 8 chars.

GET https://cloud.appwrite.io/v1/account/identities

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

Parameters

Field Name	Type	Description	Default
queries	array	Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry	[]
total	boolean	When set to false, the total count returned will be 0 and will not be calculated.	1

DELETE https://cloud.appwrite.io/v1/account/identities/{identityId}

** Delete an identity by its unique ID. **

Parameters

Field Name	Type	Description	Default
identityId	string	Required Identity ID.

POST https://cloud.appwrite.io/v1/account/jwts

** 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. **

Parameters

Field Name	Type	Description	Default
duration	integer	Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.	900

GET https://cloud.appwrite.io/v1/account/keys

** Get a list of all API keys from the current account. **

Parameters

Field Name	Type	Description	Default
total	boolean	When set to false, the total count returned will be 0 and will not be calculated.	1

POST https://cloud.appwrite.io/v1/account/keys

** Create a new account API key. **

Parameters

Field Name	Type	Description
name	string	Key name. Max length: 128 chars.
scopes	array	Key scopes list. Maximum of 100 scopes are allowed.
expire	string	Expiration time in ISO 8601 format. Use null for unlimited expiration.

GET https://cloud.appwrite.io/v1/account/keys/{keyId}

** Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes. **

Parameters

Field Name	Type	Description	Default
keyId	string	Required Key unique ID.

PUT https://cloud.appwrite.io/v1/account/keys/{keyId}

** Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key. **

Parameters

Field Name	Type	Description
keyId	string	Required Key unique ID.
name	string	Key name. Max length: 128 chars.
scopes	array	Key scopes list. Maximum of 100 scopes are allowed.
expire	string	Expiration time in ISO 8601 format. Use null for unlimited expiration.

DELETE https://cloud.appwrite.io/v1/account/keys/{keyId}

** Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. **

Parameters

Field Name	Type	Description	Default
keyId	string	Required Key unique ID.

GET https://cloud.appwrite.io/v1/account/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. **

Parameters

Field Name	Type	Description	Default
queries	array	Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset	[]
total	boolean	When set to false, the total count returned will be 0 and will not be calculated.	1

PATCH https://cloud.appwrite.io/v1/account/mfa

** Enable or disable MFA on an account. **

Parameters

Field Name	Type	Description	Default
mfa	boolean	Enable or disable MFA.

POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

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

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator. Must be `totp`

POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

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

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator. Must be `totp`

PUT https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

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

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator.
otp	string	Valid verification token.

PUT https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

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

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator.
otp	string	Valid verification token.

DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

** Delete an authenticator for a user by ID. **

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator.

DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}

** Delete an authenticator for a user by ID. **

Parameters

Field Name	Type	Description	Default
type	string	Required Type of authenticator.

POST https://cloud.appwrite.io/v1/account/mfa/challenges

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

Parameters

Field Name	Type	Description	Default
factor	string	Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.

POST https://cloud.appwrite.io/v1/account/mfa/challenges

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

Parameters

Field Name	Type	Description	Default
factor	string	Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.

PUT https://cloud.appwrite.io/v1/account/mfa/challenges

** 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. **

Parameters

Field Name	Type	Description	Default
challengeId	string	ID of the challenge.
otp	string	Valid verification token.

PUT https://cloud.appwrite.io/v1/account/mfa/challenges

** 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. **

Parameters

Field Name	Type	Description	Default
challengeId	string	ID of the challenge.
otp	string	Valid verification token.

GET https://cloud.appwrite.io/v1/account/mfa/factors

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

GET https://cloud.appwrite.io/v1/account/mfa/factors

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

GET https://cloud.appwrite.io/v1/account/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. **

GET https://cloud.appwrite.io/v1/account/mfa/recovery-codes

POST https://cloud.appwrite.io/v1/account/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. **

POST https://cloud.appwrite.io/v1/account/mfa/recovery-codes

PATCH https://cloud.appwrite.io/v1/account/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. **

PATCH https://cloud.appwrite.io/v1/account/mfa/recovery-codes

PATCH https://cloud.appwrite.io/v1/account/name

** Update currently logged in user account name. **

Parameters

Field Name	Type	Description	Default
name	string	User name. Max length: 128 chars.

PATCH https://cloud.appwrite.io/v1/account/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. **

Parameters

Field Name	Type	Description	Default
password	string	New user password. Must be at least 8 chars.
oldPassword	string	Current user password. Must be at least 8 chars.

PATCH https://cloud.appwrite.io/v1/account/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. **

Parameters

Field Name	Type	Description	Default
phone	string	Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
password	string	User password. Must be at least 8 chars.

GET https://cloud.appwrite.io/v1/account/prefs

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

PATCH https://cloud.appwrite.io/v1/account/prefs

** 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. **

Parameters

Field Name	Type	Description	Default
prefs	object	Prefs key-value JSON object.	{}

POST https://cloud.appwrite.io/v1/account/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. **

Parameters

Field Name	Type	Description	Default
email	string	User email.
url	string	URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

PUT https://cloud.appwrite.io/v1/account/recovery

** 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. **

Parameters

Field Name	Type	Description
userId	string	User ID.
secret	string	Valid reset token.
password	string	New user password. Must be between 8 and 256 chars.

GET https://cloud.appwrite.io/v1/account/sessions

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

DELETE https://cloud.appwrite.io/v1/account/sessions

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

POST https://cloud.appwrite.io/v1/account/sessions/anonymous

** 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. **

POST https://cloud.appwrite.io/v1/account/sessions/email

** 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. **

Parameters

Field Name	Type	Description	Default
email	string	User email.
password	string	User password. Must be at least 8 chars.

PUT https://cloud.appwrite.io/v1/account/sessions/magic-url

** 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. **

Parameters

Field Name	Type	Description	Default
userId	string	User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
secret	string	Valid verification token.

PUT https://cloud.appwrite.io/v1/account/sessions/phone

Parameters

Field Name	Type	Description	Default
userId	string	User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
secret	string	Valid verification token.

POST https://cloud.appwrite.io/v1/account/sessions/token

Parameters

Field Name	Type	Description	Default
userId	string	User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
secret	string	Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.

GET https://cloud.appwrite.io/v1/account/sessions/{sessionId}

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

Parameters

Field Name	Type	Description	Default
sessionId	string	Required Session ID. Use the string 'current' to get the current device session.

PATCH https://cloud.appwrite.io/v1/account/sessions/{sessionId}

** 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. **

Parameters

Field Name	Type	Description	Default
sessionId	string	Required Session ID. Use the string 'current' to update the current device session.

DELETE https://cloud.appwrite.io/v1/account/sessions/{sessionId}

** 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. **

Parameters

Field Name	Type	Description	Default
sessionId	string	Required Session ID. Use the string 'current' to delete the current device session.

PATCH https://cloud.appwrite.io/v1/account/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. **

POST https://cloud.appwrite.io/v1/account/tokens/email

** Sends the user an email with a secret key for creating a session. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored. Then, the user will receive an email with the one-time password. 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. **

Parameters

Field Name	Type	Description
userId	string	User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.
email	string	User email.
phrase	boolean	Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.

POST https://cloud.appwrite.io/v1/account/tokens/magic-url

** 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.

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

Parameters

Field Name	Type	Description
userId	string	Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.
email	string	User email.
url	string	URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.
phrase	boolean	Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.

GET https://cloud.appwrite.io/v1/account/tokens/oauth2/{provider}

** 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. **

Parameters

Field Name	Type	Description	Default
provider	string	Required OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
success	string	URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.
failure	string	URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.
scopes	array	A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.	[]

POST https://cloud.appwrite.io/v1/account/tokens/phone

** 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. **

Parameters

Field Name	Type	Description	Default
userId	string	Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.
phone	string	Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

POST https://cloud.appwrite.io/v1/account/verifications/email

** 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. **

Parameters

Field Name	Type	Description	Default
url	string	URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

POST https://cloud.appwrite.io/v1/account/verifications/email

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. **

Parameters

Field Name	Type	Description	Default
url	string	URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

PUT https://cloud.appwrite.io/v1/account/verifications/email

** 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. **

Parameters

Field Name	Type	Description	Default
userId	string	User ID.
secret	string	Valid verification token.

PUT https://cloud.appwrite.io/v1/account/verifications/email

Parameters

Field Name	Type	Description	Default
userId	string	User ID.
secret	string	Valid verification token.

POST https://cloud.appwrite.io/v1/account/verifications/phone

** 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. **

PUT https://cloud.appwrite.io/v1/account/verifications/phone

** 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. **

Parameters

Field Name	Type	Description	Default
userId	string	User ID.
secret	string	Valid verification token.

FilesExpand file tree

account.md

Latest commit

History

account.md

File metadata and controls

Account Service

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters