Skip to content

App banner

Manage the rules that show informational or blocking banners on apps across your organization.

Operations

Retrieve the app banner configuration

Request

Returns your organization's current app banner 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
GET
/v1/controls/appBanner/configuration
curl -i -X GET \
  https://api.pushsecurity.com/v1/controls/appBanner/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

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