Xsolla-logo

サイレント認証Client-side

get/social/{cross_social_provider_name}/cross_auth

Steam、Xbox、Stone、またはEpic GamesのユーザーJWTをプロジェクト(projectId)内のJWTと交換します。

ユーザーをプロジェクトにリダイレクトするためのリンクが表示されます。

サイレント認証を有効にするには、この説明をご利用ください。

Request
path Parameters
cross_social_provider_name
required
string

ユーザーが認証したプラットフォーム名。以下の値を指定できます:steamxboxepicgames

query Parameters
projectId
required
string <uuid>

パブリッシャーアカウントからのログインプロジェクトID。

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

ユーザーまたはソーシャルネットワークから追加で要求され、JWTに書き込まれる必要があるパラメータのリスト。パラメータはカンマで区切る必要があります。例えば、email

emailを要求し、ソーシャルネットワークからemail値で応答がなかった時:

  • ログインウィジェットを統合した場合、対応するフォームにメールアドレスを入力するよう要求されます。
  • Login APIを導入した場合、ユーザーには、独自のインターフェースの対応するフォームにメールアドレスを入力するよう求める必要があります。このフォームのURLをカスタマーサクセスマネージャーに送信してください。

メールアドレスが入力された後、ユーザーはメールアドレス確認メッセージを受け取ります。メール確認を無効にする場合は、カスタマーサクセスマネージャーまでお問い合わせください。

session_ticket
string

Session ticket received from the platform encoded according to the Base64 standard.

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"

既存のユーザーJWT値を非アクティブ化し、このコールによって生成されたものをアクティブ化するかどうかを示します。次の値を指定できます。

  • 1 は、既存の値を非アクティブ化し、新しい値をアクティブ化します。
  • 0 は、既存の値をアクティブ化したままにします。
app_id
string

Your app ID on the platform. Required if the platform where the user is authorized is Steam.

code
string

プラットフォームから受け取ったコード。

is_redirect
boolean
Default: true

エクソラログインサーバーがどのように応答すべきかを示します。以下の値を設定した場合:

  • true値の場合、エクソラログインサーバーは302応答コードを返します。 ユーザーJWTを使用したユーザーリダイレクトのURLは、Locationヘッダーに含まれます。
  • false値の場合、エクソラログインサーバーは200応答コードを返します。 ユーザーJWTを使用したユーザーリダイレクトのURLは、応答の本文に含まれます。
no_user_creation
boolean
Default: false

Do not create new user if they not exist yet. Existing users will be authorized as usual

Responses
200

OK

302

リダイレクション

400

無効なリクエスト

404

見つかりません

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

Request samples
curl --request GET \
  --url 'https://login.xsolla.com/api/social/{cross_social_provider_name}/cross_auth?projectId=SOME_STRING_VALUE&login_url=SOME_STRING_VALUE&fields=SOME_ARRAY_VALUE&session_ticket=SOME_STRING_VALUE&payload=SOME_STRING_VALUE&with_logout=0&app_id=SOME_STRING_VALUE&code=SOME_STRING_VALUE&is_redirect=true&no_user_creation=false'
Response samples
application/json
{
  • "login_url": "string"
}