appwrite/app/sdks/php/docs/auth.md

Auth Service

Login

POST https://appwrite.io/v1/auth/login

** Allow the user to login into his account by providing a valid email and password combination. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.

Please notice 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.

When accessing this route using Javascript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy. **

Parameters

Field Name	Type	Description	Default
email	string	User account email address
password	string	User account password
success	string	URL to redirect back to your app after a successful login attempt.
failure	string	URL to redirect back to your app after a failed login attempt.

Login with OAuth

GET https://appwrite.io/v1/auth/login/oauth/{provider}

** Allow the user to login to his account using the OAuth provider of his choice. Each OAuth 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. **

Parameters

Field Name	Type	Description	Default
provider	string	Required OAuth Provider. Currently, supported providers are: bitbucket, facebook, github, gitlab, google, microsoft, linkedin, slack, dropbox, amazon, vk
success	string	Required URL to redirect back to your app after a successful login attempt.
failure	string	Required URL to redirect back to your app after a failed login attempt.

Logout Current Session

DELETE https://appwrite.io/v1/auth/logout

** Use this endpoint to log out the currently logged in user from his account. When successful this endpoint will delete the user session and remove the session secret cookie from the user client. **

Logout Specific Session

DELETE https://appwrite.io/v1/auth/logout/{id}

** Use this endpoint to log out the currently logged in user from all his account sessions across all his different devices. When using the option id argument, only the session unique ID provider will be deleted. **

Parameters

Field Name	Type	Description	Default
id	string	Required User specific session unique ID number. if 0 delete all sessions.

Password Recovery

POST https://appwrite.io/v1/auth/recovery

** Sends the user an email with a temporary secret token for password reset. When the user clicks the confirmation link he is redirected back to your app password reset redirect URL with a secret token and email address values attached to the URL query string. Use the query string params to submit a request to the /auth/password/reset endpoint to complete the process. **

Parameters

Field Name	Type	Description	Default
email	string	User account email address.
reset	string	Reset URL in your app to redirect the user after the reset token has been sent to the user email.

Password Reset

PUT https://appwrite.io/v1/auth/recovery/reset

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

Please notice 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
userId	string	User account email address.
token	string	Valid reset token.
password-a	string	New password.
password-b	string	New password again.

Register

POST https://appwrite.io/v1/auth/register

** Use this endpoint to allow a new user to register an account in your project. Use the success and failure URLs to redirect users back to your application after signup completes.

If registration completes successfully user will be sent with a confirmation email in order to confirm he is the owner of the account email address. Use the confirmation parameter to redirect the user from the confirmation email back to your app. When the user is redirected, use the /auth/confirm endpoint to complete the account confirmation.

Please notice 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.

When accessing this route using Javascript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy. **

Parameters

Field Name	Type	Description	Default
email	string	Account email
password	string	User password
confirm	string	Confirmation URL to redirect user after confirm token has been sent to user email
success	string	Redirect when registration succeed
failure	string	Redirect when registration failed
name	string	User name

Confirmation

POST https://appwrite.io/v1/auth/register/confirm

** Use this endpoint to complete the confirmation of the user account email address. Both the userId and token arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the /auth/register endpoint. **

Parameters

Field Name	Type	Description	Default
userId	string	User unique ID
token	string	Confirmation secret token

Resend Confirmation

POST https://appwrite.io/v1/auth/register/confirm/resend

** This endpoint allows the user to request your app to resend him his email confirmation message. The redirect arguments act the same way as in /auth/register endpoint.

Please notice 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
confirm	string	Confirmation URL to redirect user to your app after confirm token has been sent to user email.