Skip to main content

LegacySessionTokenAuthenticator

Deprecated - use SessionTokenAuthenticator instead. Authenticator for requests authenticated using session tokens. A session token is a random value generated by a server to identify a specific user for the duration of one interaction session.

  • type: object
  • required: ["type","header","login_url","session_token_response_key","validate_session_url"]
  • Deprecated: true

type​

  • Required: Yes
  • type: string
  • enum: ["LegacySessionTokenAuthenticator"]

The name of the session token header that will be injected in the request

  • Required: Yes
  • type: string

Examples:

X-Session

login_url​

Path of the login URL (do not include the base URL)

  • Required: Yes
  • type: string

Examples:

session

session_token​

Session token to use if using a pre-defined token. Not needed if authenticating with username + password pair

  • Required: No
  • type: string

session_token_response_key​

Name of the key of the session token to be extracted from the response

  • Required: Yes
  • type: string

Examples:

id

username​

Username used to authenticate and obtain a session token

  • Required: No
  • type: string

Examples:

 {{ config['username'] }}

password​

Password used to authenticate and obtain a session token

  • Required: No
  • type: string
  • default: ``

Examples:

{{ config['password'] }}

validate_session_url​

Path of the URL to use to validate that the session token is valid (do not include the base URL)

  • Required: Yes
  • type: string

Examples:

user/current

$parameters​

  • Required: No
  • type: object
Was this page helpful?