Create Account Session with OAuth2

GET

/account/sessions/oauth2/{provider}

account

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 there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user..

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://appwrite.io/v1/account/sessions/oauth2/'

Response Example

{}

Request

Path Params

provider

string

required

OAuth2 Provider. Currently, supported providers are: amazon, apple, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, vk, yahoo, yandex, wordpress.

Query Params

success

string

optional

URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

failure

string

optional

URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.

scopes

array[string]

optional

A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes.

Responses

🔵301File

application/json

Body

object {0}

Modified at 2023-08-16 07:28:13

Create Anonymous Session

Delete Account Session