Venus Control Suite Data Studio: Managed Token Authentication FAQ

1. Why are there so many options for the user to click or choose?
   • Advanced security methods can require additional parameters to configure authentication.
   • Different providers may use different authentication standards and response formats. Data Studio provides configurable options to support a variety of authentication requirements.
2. What are the input fields and what do they do?
   1. Post URL
      • The Post URL is the authentication endpoint used to start the authentication process. This value is typically provided by the data provider.
   2. Request Body
      • The Request Body contains the authentication information required by the provider.
        • This may include:
          • Credentials
          • Authentication parameters
          • Provider-specific settings
      • Sensitive information in the Request Body should be handled securely.
   3. Access Token Path
      • The Access Token Path identifies where the access token is located in the authentication response.
   4. Refresh Token Path
      • The Refresh Token Path identifies where the refresh token is located in the authentication response.
      • Not all providers use refresh tokens.
   5. Expiry Path
      • The Expiry Path identifies where the token expiration value is located in the authentication response.
   6. Expiry Type
      • The Expiry Type tells Data Studio when a token should be refreshed.
      • The selected value should match the authentication provider's documentation.
3. What are the dropdown options used for?
   • The dropdown options allow users to select authentication values returned by the provider.
   • Some authentication responses may contain multiple token values and the correct option must be selected. 
4. How are the dropdowns populated?
   • Data Studio parses the authentication response and attempts to identify token and expiration values automatically.
   • The available values are then displayed in the dropdown lists.
5. Why does Data Studio parse the response for tokens?
   • Authentication providers do not always use the same naming convention for token values.
   • Examples may include:
     • AccessToken
     • Access_Token
     • accessToken
   • Data Studio attempts to identify these values automatically to simplify configuration.
6. What happens if I do not see the token option I need?
   • A custom option is available to manually enter a path.
   • Some providers use unique response structures or nested values that may not be automatically identified.
     • Example: data.tokens.access_token
7. Can I test the authentication connection?
   • Yes, After entering the required authentication information, select Connect.
   • A successful connection displays a success message and Data Studio attempts to populate the authentication values from the provider response.
8. What happens if I select the wrong Expiry Type?
   • Selecting an incorrect Expiry Type can affect token refresh behavior.
   • If the token refreshes too frequently:
     • Additional authentication requests may be generated.
     • Providers may reject excessive requests.
   • If the token refreshes too slowly:
     • The token may expire before Data Studio requests a replacement.
     • Data updates may stop until a new token is acquired.
9. What does Relative mean in the Expiry Type options?
   • Relative means the token expires a specified amount of time after it is created.
   • Examples representing the same 24-hour expiration period:
     • Relative (ms) = 86400000
     • Relative Seconds = 86400
     • Relative Minutes = 1440
     • Relative Hours = 24
     • Relative Days = 1
   • Each option represents the same amount of time using a different unit.
10. What does Date/Time Offset mean?
    • Date/Time Offset expects an ISO 8601 date and time value that includes a UTC offset.
    • The token expires at the specific date and time provided by that value.
11. What do Unix Timestamp options mean?
    • A Unix Timestamp represents a date and time as the number of seconds or milliseconds since January 1, 1970 UTC.
    • Use:
      • Unix Timestamp (s) when the value is returned in seconds.
      • Unix Timestamp (ms) when the value is returned in milliseconds.
12. What happens after Data Studio is updated or restarted?
    • Source and token refresh operations continue after a Data Studio update or restart.
    • Data Studio stores token expiration information and uses it to determine when tokens should be refreshed.
13. Why can't I see the Request Body after the source is saved?
    • Sensitive authentication values are hidden after the source is saved.
    • This includes items such as:
      • Request bodies
      • Credentials
      • Passwords
      • Client secrets
      • API keys
      • Tokens
    • These values are hidden to help protect access to external systems and services.
14. Can I view the stored token?
    • No, Data Studio does not provide a way to view the stored token.
    • Tokens may contain sensitive information and should be handled securely. 

Related Resources
Venus Control Suite Data Studio: How to configure Managed Token authentication for a web data source?
Data Studio: How do I configure web data sources?