- Property Manager name: Auth Token 2.0 Verification
- Behavior version: The
latestrule format supports theverifyTokenAuthorizationbehavior v1.5. - Rule format status: Beta, possible breaking changes
- Access: Read/Write
- Allowed in includes: Not available for
latestrule format
Verifies Auth 2.0 tokens.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
useAdvanced | boolean | If enabled, allows you to specify advanced options such as | {"displayType":"boolean","tag":"input","type":"checkbox"}{"required":"true"} | |
location | enum | 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 | ||||
locationId | string | When | {"displayType":"string","tag":"input","type":"text"}{"required":"false","defaultValue":"__token__"} | |
algorithm | enum | Specifies the algorithm that generates the token. It needs to match the method chosen in the token generation code. | useAdvanced 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 | ||||
escapeHmacInputs | boolean | URL-escapes HMAC inputs passed in as query parameters. | useAdvanced is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"useAdvanced","op":"eq","value":true}}{"required":"false","defaultValue":"true"} |
ignoreQueryString | boolean | Enabling this removes the query string from the URL used to form an encryption key. | useAdvanced is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"useAdvanced","op":"eq","value":true}}{"required":"true"} |
key | string | 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"} | |
transitionKey | string | Specifies a transition key as a hex value. | useAdvanced is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"useAdvanced","op":"eq","value":true}}{"required":"true"} |
salt | string | Specifies a salt string for input when generating the token, which needs to match the salt value used in the token generation code. | useAdvanced is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"useAdvanced","op":"eq","value":true}}{"required":"true"} |
failureResponse | boolean | When enabled, sends an HTTP error when an authentication test fails. | {"displayType":"boolean","tag":"input","type":"checkbox"}{"required":"false","defaultValue":"true"} | |
expMaxDigits | enum | 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 |
