Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Auth Configuration JSON - Arbitrary JSON storage of any required authentication attributes for this connection. 
  • Auth Script Command - When specified this command will be triggered during RED's authentication process to this connectioneconnection.
  • Auth Expires After - Duration in mins after which RED will reconnect at the next opportunity.

...

  • Token (1,2,3) - Three new encrypted fields which can be used in connections connection strings using the token format $AUTHTKN_[1|2|3]$ for expansion at runtime. Display names can be adjusted via the RED Profile to suit a particular authentication type.

Scripted Authentication

Scripted Authentication is enabled for a connection by providing a command line to run in the new field 'Auth Script Command'. This command will be triggered by RED when it needs to authenticate with this connection for the first time and then again whenever the 'Auth Expires After' minutes have been exceeded.

When RED executes the 'Auth Script Command' this is the typical workflow: 

  1. RED UI
    1. Save the current RED Profile to disk and provide access to this Profile file and the connection name requiring authentication via environment variables.
    2. Run the 'Auth Script Command'
  2. Authentication Script
    1. Reads the RED Profile and retrieves any required Connection details from it.
    2. Perform the required authentication workflow for the connection.
    3. Updates the RED Profile on disk with refreshed Auth Tokens and other Auth Configuration values as required. 
  3. RED UI
    1. Merges the updated RED Profile file back into memory.
    2. Completes the authentication process for the connection.
    3. Resets the internal expiry for the connection based on 'Auth Expires After' mins. 


Detailed Changes in RED 10.6.0.0

...