saas_definitions
Version: v2025-01-13 | Includes use: No |
---|
Behavior name: SaaS Definitions
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 SaaS 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 originType
option is set to SAAS_DYNAMIC_ORIGIN
.
Default behavior
These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.
data "akamai_property_rules_builder" "saas_definitions" {
rules_v2025_02_18 {
name = "SaaS Definitions"
comments = "Configures how the Software as a Service feature identifies customers, applications, and users."
behavior {
saas_definitions {
customer_action = "PATH"
customer_regex = ""
customer_replace = ""
application_action = "PATH"
application_regex = ""
application_replace = ""
users_action = "COOKIE"
users_cookie = ""
users_regex = ""
users_replace = ""
}
}
}
}
"behaviors": [
{
"name": "saasDefinitions",
"options": {
"customerAction": "PATH",
"customerRegex": "",
"customerReplace": "",
"applicationAction": "PATH",
"applicationRegex": "",
"applicationReplace": "",
"usersAction": "COOKIE",
"usersCookie": "",
"usersRegex": "",
"usersReplace": ""
}
}
]
Options
Option | Description |
---|---|
customer_action |
Specifies the request component that identifies a SaaS customer. Value is one of:
|
customer_cname_enabled |
Enabling this allows you to identify customers using a CNAME chain rather than a single hostname.
|
customer_cname_level |
Specifies the number of CNAMEs to use in the chain.
|
customer_cookie |
This specifies the name of the cookie that identifies the customer.
|
customer_query_string |
This names the query parameter that identifies the customer.
|
customer_regex |
Specifies a Perl-compatible regular expression with which to substitute the request's customer ID.
|
customer_replace |
Specifies a string to replace the request's customer ID matched by
customer_regex .
|
application_action |
Specifies the request component that identifies a SaaS application. Value is one of:
|
application_cname_enabled |
Enabling this allows you to identify applications using a CNAME chain rather than a single hostname.
|
application_cname_level |
Specifies the number of CNAMEs to use in the chain.
|
application_cookie |
This specifies the name of the cookie that identifies the application.
|
application_query_string |
This names the query parameter that identifies the application.
|
application_regex |
Specifies a Perl-compatible regular expression with which to substitute the request's application ID.
|
application_replace |
Specifies a string to replace the request's application ID matched by
application_regex .
|
users_action |
Specifies the request component that identifies a SaaS user. Value is one of:
|
users_cname_enabled |
Enabling this allows you to identify users using a CNAME chain rather than a single hostname.
|
users_cname_level |
Specifies the number of CNAMEs to use in the chain.
|
users_cookie |
This specifies the name of the cookie that identifies the user.
|
users_query_string |
This names the query parameter that identifies the user.
|
users_regex |
Specifies a Perl-compatible regular expression with which to substitute the request's user ID.
|
users_replace |
Specifies a string to replace the request's user ID matched by
users_regex .
|
Updated about 1 hour ago