saasDefinitions


Configures how the Software as a Service feature identifies customers, applications, and users. A different set of options is available for each type of targeted request, each enabled with the action-suffixed option. In each case, you can use PATH, COOKIE, QUERY_‚ÄčSTRING, or HOSTNAME components as identifiers, or disable the Saa‚ÄčS behavior for certain targets. If you rely on a HOSTNAME, you also have the option of specifying a CNAME chain rather than an individual hostname. The various options suffixed regex and replace subsequently remove the identifier from the request. This behavior requires a sibling origin behavior whose origin‚ÄčType option is set to SAAS_‚ÄčDYNAMIC_‚ÄčORIGIN.

OptionTypeDescriptionRequires
customer‚ÄčActionenum

Specifies the request component that identifies a Saa‚ÄčS customer.

{"displayType":"enum","options":["DISABLED","HOSTNAME","PATH","QUERY_STRING","COOKIE"],"tag":"select"}
DISABLED

This effectively ignores customers.

HOSTNAME

In a hostname.

PATH

In the URL path.

QUERY_‚ÄčSTRING

In a query parameter.

COOKIE

In a cookie.

customer‚ÄčCname‚ÄčEnabledboolean

Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.

customer‚ÄčAction is HOSTNAME
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"customerAction","op":"eq","value":"HOSTNAME"}}
customer‚ÄčCname‚ÄčLevelnumber

Specifies the number of CNAMEs to use in the chain.

customer‚ÄčCname‚ÄčEnabled is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"customerCnameEnabled","op":"eq","value":true}}
customer‚ÄčQuery‚ÄčStringstring

This names the query parameter that identifies the customer.

customer‚ÄčAction is QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"customerAction","op":"eq","value":"QUERY_STRING"}}
customer‚ÄčRegexstring

Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.

customer‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"customerAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}
customer‚ÄčReplacestring

Specifies a string to replace the request's customer ID matched by customer‚ÄčRegex.

customer‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"customerAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}
application‚ÄčActionenum

Specifies the request component that identifies a Saa‚ÄčS application.

{"displayType":"enum","options":["DISABLED","HOSTNAME","PATH","QUERY_STRING","COOKIE"],"tag":"select"}
DISABLED

This effectively ignores applications.

HOSTNAME

In the hostname.

PATH

In the URL path.

QUERY_‚ÄčSTRING

In a query parameter.

COOKIE

In a cookie.

application‚ÄčCname‚ÄčEnabledboolean

Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.

application‚ÄčAction is HOSTNAME
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"applicationAction","op":"eq","value":"HOSTNAME"}}
application‚ÄčCname‚ÄčLevelnumber

Specifies the number of CNAMEs to use in the chain.

application‚ÄčCname‚ÄčEnabled is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"applicationCnameEnabled","op":"eq","value":true}}
application‚ÄčQuery‚ÄčStringstring

This names the query parameter that identifies the application.

application‚ÄčAction is QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"applicationAction","op":"eq","value":"QUERY_STRING"}}
application‚ÄčRegexstring

Specifies a Perl-compatible regular expression with which to substitute the request's application ID.

application‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"applicationAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}
application‚ÄčReplacestring

Specifies a string to replace the request's application ID matched by application‚ÄčRegex.

application‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"applicationAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}
users‚ÄčActionenum

Specifies the request component that identifies a Saa‚ÄčS user.

{"displayType":"enum","options":["DISABLED","HOSTNAME","PATH","QUERY_STRING","COOKIE"],"tag":"select"}
DISABLED

This effectively ignores users.

HOSTNAME

In a hostname.

PATH

In the URL path.

QUERY_‚ÄčSTRING

In a query parameter.

COOKIE

In a cookie.

users‚ÄčCname‚ÄčEnabledboolean

Enabling this allows you to identify users using a CNAME chain rather than a single hostname.

users‚ÄčAction is HOSTNAME
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"usersAction","op":"eq","value":"HOSTNAME"}}
users‚ÄčCname‚ÄčLevelnumber

Specifies the number of CNAMEs to use in the chain.

users‚ÄčCname‚ÄčEnabled is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"usersCnameEnabled","op":"eq","value":true}}
users‚ÄčQuery‚ÄčStringstring

This names the query parameter that identifies the user.

users‚ÄčAction is QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"usersAction","op":"eq","value":"QUERY_STRING"}}
users‚ÄčRegexstring

Specifies a Perl-compatible regular expression with which to substitute the request's user ID.

users‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"usersAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}
users‚ÄčReplacestring

Specifies a string to replace the request's user ID matched by users‚ÄčRegex.

users‚ÄčAction is either: HOSTNAME, PATH, COOKIE, QUERY_‚ÄčSTRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"usersAction","op":"in","value":["HOSTNAME","PATH","COOKIE","QUERY_STRING"]}}