Flex Connector Refresh Access Token
  • 18 Jan 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Flex Connector Refresh Access Token

  • Dark
    Light
  • PDF

Article Summary

This document describes the different refresh access token configuration options of the Flex Connector. In many API services, you will be required to refresh the access token. Panoply's Flex Connector supports automation of this refresh process.
First, you will need to enable the refresh of the access token and configure the specific configurations based on the required refresh process.

  • Use refresh token once - Check this box if the refresh of the access token will also generate a new refresh token
Warning

If the refresh process will refresh the refresh token and this has not been selected, the Flex Connector will not save the new refresh token and will fail in the successive collections

  • URL - Enter the refresh token URL
  • Method - Select the refresh token API call's method
    • GET
    • POST
  • POST data - This configuration is available only if the selected method is POST. Enter the JSON body data required for the refresh process. The JSON data input should be in JSON format. For example: {"param1": 123, "param2": "abc" }
  • URL Parameters - Enter & separated parameters. For example: key1=123&key2=abc
  • Headers - Enter the API call's headers in a JSON format. For example: {"Client_id": "123..."}
  • Refresh Token - Enter the refresh token. This value will automatically update if the Use refresh token once is selected.
  • Access token response key - Enter the field path to the access token in the response.
  • Refresh token response key - This configuration is available only when Use refresh token once is selected. Enter the field path to the refresh token in the response.
  • Access Token header key - Enter the header key to use with the response’s access token. By default, Panoply will use Authorization as the header.
  • Use Bearer authentication - Select if using Bearer authentication. By default, Panoply will use Bearer authentication.
  • Error status codes - Enter a ; list of the error codes that will trigger the refresh of the access token. The Flex Connector will only attempt to refresh the access token when encountering these error codes.

Was this article helpful?