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 grant as recommended by the OAuth 2.0 specification.
This refresh token needs to be kept private, similar to the access token. When using this token, keep in mind that it issues the access token without a user interaction.
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.
This can configurations are done in the
<RefreshTokenValidityPeriod>element is in seconds. By default, it is valid for one day. You can configure this accordingly.
<RenewRefreshTokenForRefreshGrant>element is by default set to true.
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 then 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.
Try out scenario
Run the following cURL command to try out the refresh token grant.