[OAuth 2.0] Silent authentication

Xsolla Developers

或

前往发布商帐户

[OAuth 2.0] Silent authentication Client-side

get/oauth2/social/{oauth2_cross_social_provider_name}/cross_auth

将Steam、Xbox或Epic Games中的用户JWT交换为您项目(projectId)中的JWT。要启用静默认证，请参阅说明。

Request

path Parameters

oauth2_cross_social_provider_name

required

string

用户授权进入的平台名称。可以是steam、xbox、epicgames。

query Parameters

client_id required	integer 您的应用程序ID。在创建OAuth 2.0客户端后获取。
response_type required	string 启用了OAuth 2.0协议项目中使用的授权类型。必须是`code`才能在响应中获取用户认证代码。必须通过生成JWT调用将收到的代码交换给JWT以完成用户认证。
state required	string 用于额外用户验证的值。通常用于抵御CSRF攻击。该值将在响应中返回。必须长于8个符号。
redirect_uri	string 在帐户确认、成功认证或密码重置确认后将用户重定向到的URL。要设置此参数，请联系您的客户成功经理或发送邮件至csm@xsolla.com。注：如果项目设置中有多个重定向URI，则该参数为必需。
session_ticket	string Session ticket received from the platform encoded according to the Base64 standard.
scope	string 范围是OAuth 2.0中的一种机制，用于限制应用程序对用户帐户的访问。可以是： `email`，用于通过社交网络进行认证或获取社交网络认证链接调用来额外请求用户的邮箱地址。 `offline`，使用来自生成JWT调用的`refresh_token`在JWT过期时刷新。 `playfab`，将SessionTicket写入JWT的`session_ticket`声明（如果您在PlayFab中存储用户数据）。如果您要处理上面未提及的自定义`scope`参数值，可以在使用此调用时设置这些参数。艾克索拉登录管理器服务器不会处理这些值，但会在收到的JWT中返回它们。
audience	string 令牌发放的对象应用程序ID。参数值在`aud` JWT 字段中传递。
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
deployment_id	string The deployment ID that the client is trying to authenticate with. This will impact interactions with other services that require a deployment. If the deployment is not public, only users who have been entitled will be able to log in. For more information on deployments and deployment IDs see Product, Sandbox, and Deployment IDs. Note: You must use this unique identifier to use the Ecommerce APIs, and to request access tokens used by game clients.

Responses

200

确定

302

重定向

400

错误的请求

404

未找到

422

无法处理的实体

429

请求过多

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/oauth2/social/{oauth2_cross_social_provider_name}/cross_auth?client_id=SOME_INTEGER_VALUE&response_type=SOME_STRING_VALUE&redirect_uri=SOME_STRING_VALUE&state=SOME_STRING_VALUE&session_ticket=SOME_STRING_VALUE&scope=SOME_STRING_VALUE&audience=SOME_STRING_VALUE&app_id=SOME_STRING_VALUE&code=SOME_STRING_VALUE&is_redirect=true&no_user_creation=false&deployment_id=SOME_STRING_VALUE'

Response samples

application/json

{"login_url": "string"
}