OAuth 2.0認証

OAuth 2.0認証Client-side

get/oauth2/auth

有効なSSOセッションの存在を確認します。認証コードとともに「redirect_url」パラメータで渡されたURLにリダイレクトします。

Request

query Parameters

response_type required	string コードが設定され、アプリケーションが成功した場合に認証コードを受け取ることを期待することを示します。 Value: "code"
client_id required	integer アプリケーションID。OAuth 2.0クライアントを作成した後で取得します。
redirect_uri required	string このURLは、開発者がアプリケーション作成時に登録したURLのいずれかと一致する必要があり、一致しない場合は認証サーバーがリクエストを拒否する必要があります。このパラメータを設定するには、カスタマーサクセスマネージャにお問い合わせください。
scope required	string リクエストは、アプリケーションが要求する追加的なアクセスを示す1つ以上のスコープ値を持つことができます。認証サーバーは、要求されたスコープをユーザーに表示する必要があります。
state required	string 状態パラメータは、アプリケーションがリクエスト固有のデータを保存したり、CSRF攻撃を防止するために使用されます。認証サーバーは、変更されていない状態の値をアプリケーションに返さなければなりません。これはおすすめのパラメータです。
audience required	string オーディエンスパラメータは、urlエンコードされたスペース(+または%20)で区切られた複数の文字列を含むことができます。オーディエンスの値自体も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 チャレンジを生成するために使用されるメソッドです。現時点では、`code_challenge`を生成するために`S256`メソッドしか使用できません。 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": { }
}
}