Autorização OAuth 2.0

Autorização OAuth 2.0Client-side

get/oauth2/auth

Verifica a presença de uma sessão SSO válida. Redireciona para o URL passado no parâmetro redirect_url com um código de autorização.

Request

query Parameters

response_type required	string Será definido como código, indicando que o aplicativo espera receber um código de autorização se for bem-sucedido. Value: "code"
client_id required	integer Seu ID de aplicativo. Obtenha-o depois de criar um cliente OAuth 2.0.
redirect_uri required	string Esse URL deve corresponder a um dos URLs que o desenvolvedor registrou ao criar o aplicativo, e o servidor de autorização deve rejeitar a solicitação se ela não corresponder. Para configurar esse parâmetro, entre em contato com o Gerente de Sucesso do Cliente.
scope required	string A solicitação pode ter um ou mais valores de escopo indicando acesso adicional solicitado pelo aplicativo. O servidor de autorização precisará exibir os escopos solicitados para o usuário.
state required	string O parâmetro state é usado pelo aplicativo para armazenar dados específicos da solicitação e/ou impedir ataques CSRF. O servidor de autorização deve retornar o valor de estado não modificado de volta ao aplicativo. Este é o parâmetro recomendado.
audience required	string O parâmetro audience pode conter várias cadeias de caracteres separadas por um espaço codificado por url (+ ou %20). Os próprios valores de audience também devem ser codificados por url.
popup	boolean Default: false Se true for passado, o método redirecionará para o widget primeiro e, em seguida, para o retorno de chamada do parceiro. Se false, o método redirecionará diretamente para o retorno de chamada do parceiro.
code_challenge	string Desafio gerado a partir do `code_verifier` (https://datatracker.ietf.org/doc/html/rfc7636#section-4-2).
code_challenge_method	string Método utilizado para gerar o desafio. Por enquanto, você só pode usar o método `S256` para gerar `code_challenge`. Value: "S256"
widget_only	boolean Parâmetro de serviço para fluxo pop-up. Não afeta o comportamento da API.
enable_post_message_login	boolean Parâmetro de serviço para fluxo pop-up. Não afeta o comportamento da API.
disable_socials	boolean Parâmetro de serviço para fluxo pop-up. Não afeta o comportamento da 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 serviço para fluxo pop-up. Não afeta o comportamento da API.
disable_passwordless_phone	boolean Parâmetro de serviço para fluxo pop-up. Não afeta o comportamento da API.
is_xsolla_link	boolean Parâmetro de serviço para fluxo pop-up. Não afeta o comportamento da API.

Responses

302

Redirecionamento

400

Pedido incorreto

404

Não encontrado

418

Eu sou um bule

422

Entidade não processável

429

Pedidos demais

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