Autorización de OAuth 2.0

Autorización de OAuth 2.0Client-side

get/oauth2/auth

Verifica la presencia de una sesión SSO válida. Redirige a la URL transmitida en el parámetro redirect_url con un código de autorización.

Request

query Parameters

response_type required	string Se establecerá en el código, indicando que la aplicación prevé recibir un código de autorización si funciona correctamente. Value: "code"
client_id required	integer Su ID de aplicación. Obténgalo después de crear un cliente de OAuth 2.0.
redirect_uri required	string Esta URL debe coincidir con una de las URL que el desarrollador registró al crear la aplicación, y el servidor de autorización debe rechazar la solicitud si no coincide. Para configurar este parámetro, contacte con su gestor del éxito del cliente.
scope required	string La solicitud puede tener uno o más valores de 'scope' (ámbito) que indiquen el acceso adicional solicitado por la aplicación. El servidor de autorización deberá mostrar al usuario los ámbitos solicitados.
state required	string La aplicación utiliza el parámetro de estado para almacenar datos específicos de la solicitud o evitar ataques de CSRF. El servidor de autorización debe devolver a la aplicación el valor de estado sin modificar. Este es el parámetro recomendado.
audience required	string El parámetro 'audience' (audiencia) puede contener varias cadenas separadas por un espacio con codificación URL (+ o %20). Los propios valores de audiencia también deben estar tener una codificación URL.
popup	boolean Default: false Si se transmite "true", el método redirigirá primero al widget y, luego, a la devolución de llamada del socio. Si es "false", el método redirigirá directamente a la devolución de llamada del socio.
code_challenge	string Desafío generado a partir del comprobador de código `code_verifier` (https://datatracker.ietf.org/doc/html/rfc7636#section-4-2).
code_challenge_method	string Método utilizado para generar el desafío. Por ahora, sólo puede utilizar el método "S256" para generar el `code_challenge`. Value: "S256"
widget_only	boolean Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la API.
enable_post_message_login	boolean Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la API.
disable_socials	boolean Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la 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 Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la API.
disable_passwordless_phone	boolean Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la API.
is_xsolla_link	boolean Parámetro de servicio para el flujo emergente. No afecta al comportamiento de la API.

Responses

302

Redireccionamiento

400

Bad Request (Solicitud errónea)

404

Not Found (No encontrado)

418

"I’m a teapot" (Soy una tetera)

422

Unprocessable Entity (Entidad no procesable)

429

Too Many Requests (Demasiadas solicitudes)

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": { }
}
}