Auth: Refresh Access Token

🔗

API Reference: Refresh Token

Overview

When your access token expires (after 30 minutes), you can obtain a new one without re-authenticating by using the refresh token.

• The refresh request returns a new access token and a new refresh token.
• Once issued, the new tokens immediately invalidate all previously issued access and refresh tokens.

How It Works

1. Send a POST request to /configuration-management/api/v1/admin-accounts/oauth/refresh-token with your refresh token in the request body.
2. Receive new Access and Refresh tokens in the response.
3. Replace the expired access token in your API requests with the new one.

Token Refresh Recommendations

To optimise performance and reduce unnecessary processing overhead, avoid refreshing the access token before every request, as this can introduce additional latency, particularly for transaction processing. It is recommended to refresh the token:

• Only when an authentication error is returned, indicating that the token has expired, OR
• Proactively on a scheduled basis, approximately every 30 minutes.