Skip to content
/
Replace the app banner (U...

Replace the app banner (URL pattern) configuration

Request

Replaces your organization's app banner (URL pattern) configuration with the configuration you send. Any rule you don't include is deleted.

A rule with an id updates the existing rule with that id. A rule without an id is created. Rules are evaluated in the order you send them, and the first rule that matches wins.

To change part of the configuration, retrieve it first, apply your changes, and send the complete configuration back.

Security
x-api-key
Bodyapplication/jsonrequired

The complete set of rules to save.

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:
{}
curl -i -X PUT \
  https://eu1.api.pushsecurity.com/v1/controls/appBannerUrlPattern/configuration \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "globals": {},
    "rules": []
  }'

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": [ … ]
        }
      }
    }
  ]
}