GuideReference
TrainingSupportCommunity

verify_​token_​authorization


Verifies Auth 2.​0 tokens.

OptionTypeDescriptionRequires
use_​advancedboolean

If enabled, allows you to specify advanced options such as algorithm, escape_​hmac_​inputs, ignore_​query_​string, transition_​key, and salt.

{"displayType":"boolean","tag":"input","type":"checkbox"}
locationenum

Specifies where to find the token in the incoming request.

{"displayType":"enum","options":["COOKIE","QUERY_STRING","CLIENT_REQUEST_HEADER"],"tag":"select"}
Supported values:
CLIENT_REQUEST_HEADER
COOKIE
QUERY_STRING
location_​idstring

When location is CLIENT_​REQUEST_​HEADER, specifies the name of the incoming request's header where to find the token.

{"displayType":"string","tag":"input","type":"text"}
algorithmenum

Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code.

use_​advanced is true
{"displayType":"enum","options":["SHA256","SHA1","MD5"],"tag":"select"}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
Supported values:
MD5
SHA1
SHA256
escape_​hmac_​inputsboolean

URL-escapes HMAC inputs passed in as query parameters.

use_​advanced is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
ignore_​query_​stringboolean

Enabling this removes the query string from the URL used to form an encryption key.

use_​advanced is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
keyobject array

The shared secret used to validate tokens, which needs to match the key used in the token generation code.

{"displayType":"object array","tag":"input","todo":true}
transition_​keyobject array

Specifies a transition key as a hex value.

use_​advanced is true
{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
saltobject array

Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code.

use_​advanced is true
{"displayType":"object array","tag":"input","todo":true}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
failure_​responseboolean

When enabled, sends an HTTP error when an authentication test fails.

{"displayType":"boolean","tag":"input","type":"checkbox"}