Page Comparison

...

Recommended use

The refresh token grant can be used when the current access token is expired or

...

when a new access token is needed.

...

With this grant type

...

, the refresh token

...

acts as a credential and is issued to the client by the authorization server. Issuing a refresh token is optional and if the authorization server issues a refresh token, it is included when issuing an access token. WSO2 Identity Server issues refresh tokens for all other grant types other than the implicit

...

and client credentials grant types, as recommended by the OAuth 2.0 specification

...

. 

Flow:

In order to use this grant type, a refresh token needs to be already received when using a grant type like authorization code, password or client credentials. Then using this received refresh token, a new access token can be received along with a new refresh token without going through any other additional steps.

Recommanded Use:

This refresh token needs to be kept secret similar to the access token. This grant type should be used bearing in mind that, this is issuing access token without a user interaction.

Configurations:

The flow

A refresh token has to be obtained before using it with a grant type such as the authorization code or password grant type. Using the obtained refresh token, you can obtain a new access token along with a renewed refresh token without having to go through any other additional steps.

Configurations

1. The <RefreshTokenValidityPeriod> element is in seconds. By default, it is valid for one day. Configure it accordingly. 

2. The <RenewRefreshTokenForRefreshGrant> element is set to true by default.

   Info
   The refresh token is renewed when the refresh grant is used to get an access token. A new refresh token is issued with a new expiry time and the previous refresh token is made inactive and can no longer be used. If this element is set to false, unless the refresh token has expired, the same refresh token is returned.

   Code Block
   language xml theme Eclipse
   <!-- Validity period for refresh token --> <RefreshTokenValidityPeriod>84600</RefreshTokenValidityPeriod> ... <!-- Enable renewal of refresh token for refresh_token grant --> <RenewRefreshTokenForRefreshGrant>true</RenewRefreshTokenForRefreshGrant>

• RefreshTokenValidityPeriod is mentioned in seconds. By default it is valid for one day.
• By default "RenewRefreshTokenForRefreshGrant" set to true,
  • • we renew the refresh token when refresh grant is used to get an access token --> a new refresh token is issued with a new expiry time
    • previous refresh token is then inactive and can no longer be used
  • If set false,
    • unless refresh token is expired, the same refresh token is returned. (Please refer https://wso2.org/jira/browse/IDENTITY-4298 for a known issue in this flow, for the fix.)

...

Try it out

Run the following cURL command to try out the refresh token grant. 

curl -k -d "grant_type=refresh_token&refresh_token=<refresh_token>" -H "Authorization: Basic <Base64Encoded(Client_Id:Client_Secret)>" -H "Content-Type: application/x-www-form-urlencoded" https://localhost:9443/oauth2/token

...