Skip to content
/
Retrieve the app banner (...

Retrieve the app banner (URL pattern) configuration

Request

Returns your organization's current app banner (URL pattern) configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first.

Security
x-api-key
curl -i -X GET \
  https://eu1.api.pushsecurity.com/v1/controls/appBannerUrlPattern/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
rulesArray of objects(App Banner (URL Pattern) Rule)required

Complete list of App Banner (URL Pattern) rules.

globalsobject

Reserved for control-wide settings. Empty for this control.

Example:
{}
Response
{
  "globals": {},
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Warn on internal admin portal",
      "enabled": true,
      "mode": "INFORM",
      "title": "Handle with care",
      "subtext": "This is an internal admin tool. Do not paste customer data.",
      "buttonText": "I understand",
      "allowReasonSubmission": false,
      "displayFrequency": "ONCE_PER_BROWSER",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "urlPatterns": {
          "matches": [ … ]
        }
      }
    }
  ]
}