Skip to content
/
Replace the app banner co...

Replace the app banner configuration

Request

Replaces your organization's app banner 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 Rule)required

Complete list of App Banner rules.

globalsobject

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

Example:
{}
curl -i -X PUT \
  https://api.pushsecurity.com/v1/controls/appBanner/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 Rule)required

Complete list of App Banner rules.

globalsobject

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

Example:
{}
Response
{
  "globals": {},
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Warn Finance about risky apps",
      "enabled": true,
      "mode": "ACKNOWLEDGE",
      "title": "Approved apps only",
      "subtext": "Please only use apps approved by IT.",
      "buttonText": "I understand",
      "allowReasonSubmission": true,
      "displayFrequency": "ONCE_PER_BROWSER",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "appTypes": {
          "matches": [ … ]
        },
        "appLabels": {
          "matches": [ … ]
        },
        "appCategories": {
          "matches": [ … ]
        },
        "approvalStatuses": {
          "matches": [ … ]
        },
        "sensitivityLevels": {
          "matches": [ … ]
        }
      }
    }
  ]
}