Skip to content

MFA enforcement

Manage the rules that enforce multi-factor authentication across your organization.

Operations

Retrieve the MFA enforcement configuration

Request

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

Responses

OK

Bodyapplication/json
rulesArray of objects(MFA Enforcement Rule)required

Complete list of MFA Enforcement rules.

globalsobject

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

Example:
{}
Response
{
  "globals": {},
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Require MFA acknowledgement for Finance",
      "enabled": true,
      "mode": "ACKNOWLEDGE",
      "title": "Enable MFA",
      "subtext": "Your account is missing MFA. Please enable it to continue.",
      "buttonText": "I understand",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "appTypes": {
          "matches": [ … ]
        },
        "appLabels": {
          "matches": [ … ]
        },
        "appCategories": {
          "matches": [ … ]
        },
        "approvalStatuses": {
          "matches": [ … ]
        },
        "sensitivityLevels": {
          "matches": [ … ]
        }
      }
    }
  ]
}