OAuth 2.0授权

OAuth 2.0授权Client-side

get/oauth2/auth

检查是否存在有效的SSO会话。跳转到redirect_url参数中传递的URL并包含一个含授权代码。

Request

query Parameters

response_type required	string 将设置为code，表示应用程序预期在成功时收到一个授权码。 Value: "code"
client_id required	integer 您的应用程序ID。在创建OAuth 2.0客户端后获取。
redirect_uri required	string 此URL必须与开发者在创建应用程序时注册的URL之一匹配，如果不匹配，授权服务器应拒绝该请求。要设置此参数，请联系您的客户成功经理。
scope required	string 请求可以有一个或多个范围值，指示应用程序请求的额外访问权限。授权服务器将需要向用户显示请求的范围。
state required	string 应用程序使用state参数来存储特定于请求的数据和/或防止CSRF攻击。授权服务器必须将未修改的状态值返回给应用程序。此为推荐参数。
audience required	string audience参数可能包含用url编码的空格（+或%20）分隔的多个字符串。audience值本身也必须为url编码。
popup	boolean Default: false 如传入true，方法将首先跳转到小组件，然后再跳转到合作伙伴的回调。如传入false，方法将直接跳转到合作伙伴的回调。
code_challenge	string 从`code_verifier`生成的质询码（https://datatracker.ietf.org/doc/html/rfc7636#section-4-2）。
code_challenge_method	string 用于生成质询码的方法。目前只能使用`S256`方法来生成`code_challenge`。 Value: "S256"
widget_only	boolean 弹出流的服务参数。不影响API行为。
enable_post_message_login	boolean 弹出流的服务参数。不影响API行为。
disable_socials	boolean 弹出流的服务参数。不影响API行为。
fail_auth_url	string If passed then method will redirect on this URL in case of a missing session for authentication and obtaining new session.
disable_passwordless_email	boolean 弹出流的服务参数。不影响API行为。
disable_passwordless_phone	boolean 弹出流的服务参数。不影响API行为。
is_xsolla_link	boolean 弹出流的服务参数。不影响API行为。

Responses

302

重定向

400

错误的请求

404

未找到

418

我是茶壶

422

无法处理的实体

429

请求过多

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/oauth2/auth?response_type=SOME_STRING_VALUE&client_id=SOME_INTEGER_VALUE&redirect_uri=SOME_STRING_VALUE&scope=SOME_STRING_VALUE&state=SOME_STRING_VALUE&audience=SOME_STRING_VALUE&popup=false&code_challenge=SOME_STRING_VALUE&code_challenge_method=SOME_STRING_VALUE&widget_only=SOME_BOOLEAN_VALUE&enable_post_message_login=SOME_BOOLEAN_VALUE&disable_socials=SOME_BOOLEAN_VALUE&fail_auth_url=SOME_STRING_VALUE&disable_passwordless_email=SOME_BOOLEAN_VALUE&disable_passwordless_phone=SOME_BOOLEAN_VALUE&is_xsolla_link=SOME_BOOLEAN_VALUE' \
  --header 'accept: application/x-www-form-urlencoded'

Response samples

{"error": {"code": "003-061",
"description": "Object not found.",
"details": { }
}
}