verifyTokenAuthorization


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"}
{"required":"true"}
locationenum

Specifies where to find the token in the incoming request.

{"displayType":"enum","options":["COOKIE","QUERY_STRING","CLIENT_REQUEST_HEADER"],"tag":"select"}
{"required":"false","defaultValue":"COOKIE"}
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"}
{"required":"false","defaultValue":"__token__"}
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}}
{"required":"false","defaultValue":"SHA256"}
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}}
{"required":"false","defaultValue":"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}}
{"required":"true"}
keystring

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

{"displayType":"string","tag":"input","type":"text"}
{"required":"true"}
transition​Keystring

Specifies a transition key as a hex value.

use​Advanced is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
{"required":"true"}
saltstring

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":"string","tag":"input","type":"text"}
{"if":{"attribute":"useAdvanced","op":"eq","value":true}}
{"required":"true"}
failure​Responseboolean

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

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"required":"false","defaultValue":"true"}
exp​Max​Digitsenum

TBD

{"displayType":"enum","options":["DEFAULT","10","11","12","13"],"tag":"select"}
{"if":{"op":"or","params":[{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"Auth_Token_Max_Digits_Trial"},{"attribute":"property.modulesOnContract","op":"contains","scope":"global","value":"Auth_Token_Max_Digits_Trial"}]}}
{"required":"false","defaultValue":"DEFAULT"}
DEFAULT

TBD

10

TBD

11

TBD

12

TBD

13

TBD