Xsolla-logo

Auth via social networkClient-side

get/social/{provider_name}/login_redirect

Redirects the user to the page for authentication via the specified social network.

Request
path Parameters
provider_name
required
string

Name of the social network connected to Login in Publisher Account. Can be: amazon, apple, babka, baidu, battlenet, discord, epicgames, facebook, github, google,kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo,vk, wechat, weibo, xbox, yahoo, yandex, youtube.

If you store user data in PlayFab, only twitch is available.

query Parameters
projectId
required
string <uuid>

Login project ID from Publisher Account.

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.

fields
Array of strings non-empty

List of parameters which must be requested from the user or social network additionally and written to the JWT. The parameters must be separated by a comma. For example, email.

When the email is requested and the social network did not respond with the email value:

  • the user will be asked to input their email in the corresponding form if you integrated Login Widget,
  • the user must be asked to input their email in the corresponding form of your own interface if you integrated Login API. Please send the URL of this form to your Customer Success Manager.

After the email is inputted, the user receives an email confirmation message. To disable email confirmation, please contact your Customer Success Manager.

payload
string

Your custom data. The value of the parameter will be returned in the payload claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.

with_logout
string
Default: "0"

Shows whether to deactivate the existing user JWT values and activate the one generated by this call. Can have the following values:

  • 1 to deactivate the existing values and activate a new one,
  • 0 to keep the existing values activated.
locale
string >= 2 characters

Region in the <language code>_<country code> format, where:

The list of social networks will be sorted from most to least used, according to the variable value.

Responses
302

Redirection

400

Bad Request

401

Bad Request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples 
curl --request GET \
  --url 'https://login.xsolla.com/api/social/{provider_name}/login_redirect?projectId=SOME_STRING_VALUE&login_url=SOME_STRING_VALUE&fields=SOME_ARRAY_VALUE&payload=SOME_STRING_VALUE&with_logout=0&locale=SOME_STRING_VALUE'
Response samples
{
  • "error": {
    }
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2024 Xsolla Inc.