Xsolla-logo

Gerar JWT

post/oauth2/token

Use esta chamada: *Para obter um [JWT de usuário](/api/login/overview/#section /Autenticação/Obtendo um token de usuário).

  • Para atualizar o JWT quando ele expirar. Funciona apenas se scope=offline for passado na chamada de registro ou autenticação.
  • Para obter um [ JWT do servidor](/api/login/overview/#section /Autenticação/Obtendo um token de servidor). A participação do usuário não é necessária.
  • Para trocar o JWT do usuário por um novo com um escopo diferente.

O uso desta chamada depende do valor do parâmetro grant_type.

Request
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string

O tipo de obtenção do JWT. Pode ser:

  • authorization_code para trocar o código recebido na chamada de autenticação para o JWT. O valor do parâmetro code deve ser especificado.
  • refresh_token para obter o JWT atualizado quando o valor anterior expirar. O valor do parâmetro refresh_token deve ser especificado.
  • client_credentials para obter o servidor JWT. Os valores dos parâmetros client_id e client_secret devem ser especificados.
  • urn:ietf:params:oauth:grant-type:token_exchange para trocar o JWT de usuário existente com um escopo diferente.
client_id
required
string

Seu ID de aplicativo. O valor desse parâmetro depende do valor do parâmetro grant_type:

Observe que os valores para os parâmetros client_secret e client_id devem ser usados do mesmo cliente.

refresh_token
string

Valor deste parâmetro recebido na resposta à última solicitação desta chamada com os valores authorization_code ou refresh_token no parâmetro grant_type. Obrigatório se grant_type=refresh_token.

client_secret
string

Sua chave secreta. O valor desse parâmetro depende do valor do parâmetro grant_type:

  • Se for authorization_code, crie um cliente OAuth 2.0 e use sua chave secreta. Obrigatório se você criou um cliente OAuth 2.0 com tipo de autenticação confidencial.
  • Se for client_credentials, entre em contato com seu Gerente de Sucesso do Cliente para criar um cliente OAuth 2.0 de servidor e obter sua chave secreta. Obrigatório para este tipo de cliente.

Observe que os valores para os parâmetros client_secret e client_id devem ser usados do mesmo cliente.

redirect_uri
string
code
string

Código de autenticação que é trocado para um JWT. Obrigatório se grant_type=authorization_code.

code_verifier
string

O verificador de código para a solicitação PKCE, que o aplicativo gerou originalmente antes da solicitação de autorização.

audience
string

Lista de domínios para os quais o token pode ser aplicado

scope
string

Uma lista de cadeias de caracteres delimitadas por espaços e que diferenciam maiúsculas de minúsculas, conforme definido na Seção 3.3 de [RFC6749], que permite ao cliente especificar o escopo desejado do token de segurança solicitado no contexto do serviço ou recurso em que o token será usado. Os valores e a semântica associada do escopo são específicos do serviço e espera-se que sejam descritos na documentação de serviço relevante.

subject_token
string

Um token de segurança que representa a identidade da parte em nome da qual a solicitação está sendo feita. Normalmente, o assunto desse token será o assunto do token de segurança emitido em resposta à solicitação.

subject_token_type
string

Um token de segurança que representa a identidade da parte em nome da qual a solicitação está sendo feita. Normalmente, o assunto desse token será o assunto do token de segurança emitido em resposta à solicitação.

Value: "access_token"
actor_token
string

Um token de segurança que representa a identidade da parte atuante. Normalmente, essa será a parte autorizada a usar o token de segurança solicitado e agir em nome do sujeito.

actor_token_type
string

Um identificador, conforme descrito na Seção 3, que indica o tipo do token de segurança no parâmetro actor_token. Isso é OBRIGATÓRIO quando o parâmetro actor_token está presente na solicitação, mas NÃO deve ser incluído de outra forma.

Value: "server_token"
Responses
200

OK

400

Pedido incorreto

404

Não encontrado

418

Eu sou um bule

422

Entidade não processável

429

Pedidos demais

Request samples
application/x-www-form-urlencoded
refresh_token=string&grant_type=string&client_secret=string&client_id=string&redirect_uri=string&code=string&code_verifier=string&audience=string&scope=string&subject_token=string&subject_token_type=access_token&actor_token=string&actor_token_type=server_token
Response samples
application/json
{
  • "access_token": "2YotnFZFEjr1zCsicMWpAA",
  • "expires_in": 3600,
  • "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
  • "scope": "email user_profile",
  • "token_type": "bearer"
}