Gerar JWT

post/oauth2/token

Use this call:

To get a user JWT.
To refresh the JWT when it expires. Works only if scope=offline is passed in the registration or authentication call.
To get a server JWT. The user participation isn’t needed.
To exchange user JWT for a new one with different scope.

Usage of this call depends on the value of the grant_type parameter.

Request

Request Body schema: application/x-www-form-urlencoded

grant_type required	string The type of getting the JWT. Can be: `authorization_code` to exchange the code received in the authentication call to the JWT. The value of the `code` parameter must be specified. `refresh_token` to get the refreshed JWT when the previous value is expired. The value of the `refresh_token` parameter must be specified. `client_credentials` to get the server JWT. The values of the `client_id` and `client_secret` parameters must be specified. `urn:ietf:params:oauth:grant-type:token_exchange` to exchange existing user JWT with different scope.
client_id required	string Seu ID de aplicativo. 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 ID de cliente. 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 o ID de cliente. 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 A list of space-delimited, case-sensitive strings, as defined in Section 3.3 of [RFC6749], that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used. The values and associated semantics of scope are service specific and expected to be described in the relevant service documentation
subject_token	string A security token that represents the identity of the party on behalf of whom the request is being made. Typically, the subject of this token will be the subject of the security token issued in response to the request.
subject_token_type	string A security token that represents the identity of the party on behalf of whom the request is being made. Typically, the subject of this token will be the subject of the security token issued in response to the request. Value: "access_token"
actor_token	string A security token that represents the identity of the acting party. Typically, this will be the party that is authorized to use the requested security token and act on behalf of the subject.
actor_token_type	string An identifier, as described in Section 3, that indicates the type of the security token in the actor_token parameter. This is REQUIRED when the actor_token parameter is present in the request but MUST NOT be included otherwise. Value: "server_token"

Responses

200

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