Xsolla-logo

OAuth 2.0-Autorisierung

get/oauth2/auth

Checks the presence of a valid SSO session. Redirects to the URL passed in the redirect_url parameter with an authorization code.

Request
query Parameters
response_type
required
string

Wird auf Code gesetzt, was darauf hinweist, dass die Anwendung im Erfolgsfall einen Autorisierungscode erwartet.

Value: "code"
client_id
required
integer

ID Ihrer Anwendung. Diese erhalten Sie, nachdem Sie einen OAuth 2.0 Client erstellt haben.

redirect_uri
required
string

This URL must match one of the URLs the developer registered when creating the application, and the authorization server should reject the request if it does not match. To set up this parameter, contact your Customer Success Manager.

scope
required
string

Die Anfrage kann einen oder mehrere Werte für den Geltungsbereich enthalten und so auf von der Anwendung angeforderte zusätzliche Zugriffsrechte hinweisen. Der Autorisierungsserver muss dem Benutzer die angeforderten Geltungsbereiche anzeigen.

state
required
string

Anhand des Zustandsparameters kann die Anwendung anforderungsspezifische Daten speichern und/oder CSRF-Angriffe abwehren. Der Autorisierungsserver muss den unveränderten Zustandswert an die Anwendung zurückgeben. Dies ist der empfohlene Parameter.

audience
required
string

Der Audience-Parameter kann mehrere Strings enthalten, die durch ein URL-codiertes Leerzeichen (+ oder %20) getrennt sind. Die Audience-Werte selbst müssen ebenfalls URL-codiert sein.

popup
boolean
Default: false

If true is passed method will redirect to widget at first and then to partner's callback. If false, method will redirect straight to partner's callback.

code_challenge
string

Generated challenge from the code_verifier (https://datatracker.ietf.org/doc/html/rfc7636#section-4-2).

code_challenge_method
string

Method used to generate the challenge. For now, you can only use the method S256 to generate code_challenge.

Value: "S256"
widget_only
boolean

Service parameter for pop up flow. Does not affect API behaviour.

enable_post_message_login
boolean

Service parameter for pop up flow. Does not affect API behaviour.

disable_socials
boolean

Service parameter for pop up flow. Does not affect API behaviour.

Responses
302

Redirection

400

Bad Request

404

Not Found

418

I’m a teapot

422

Unprocessable Entity

429

Too Many Requests

Request samples 
Response samples 
{
  • "error": {
    }
}