Skip to content
/
Replace the MFA enforceme...

Replace the MFA enforcement configuration

Request

Replaces your organization's MFA enforcement 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(MFA Enforcement Rule)required

Complete list of MFA Enforcement rules.

globalsobject

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

Example:
{}
PUT
/v1/controls/mfaEnforcement/configuration
curl -i -X PUT \
  https://api.pushsecurity.com/v1/controls/mfaEnforcement/configuration \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "globals": {},
    "rules": []
  }'

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