API
TrainingSupportCommunity

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"]}}