Batch-revoke whitelistings

POST /v1/org/{organizationId}/contexts/sign-in/{contextId}/modules/whitelistings/batch/remove

Removes many whitelist entries by MAC. Active sessions from the revoked devices are terminated.

Request

Parameter	In	Type	Required	Description
organizationId	Path	string	Yes	Organization ID.
contextId	Path	string	Yes	Sign-In Context ID.
x-auth-token	Header	string	Yes	Context API key.
macs	Body	object[]	Yes	Array of MAC-carrying objects.
macs[].mac		string	Yes	MAC, AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF.

Request example

cURL

curl -X POST "$API_BASE_URL/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/modules/whitelistings/batch/remove" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "macs": [
      { "mac": "AA:BB:CC:00:00:01" },
      { "mac": "AA:BB:CC:00:00:02" }
    ]
  }'

Response

Field	Type	Description
nrOfWhitelistingsInRevokeRequest	integer	How many MACs were in the request.
nrOfWhitelistingsThatHadActiveLoginsThatWereRevoked	integer	How many of those MACs had active sessions that were terminated as part of this call.

Response example

200

{
  "nrOfWhitelistingsInRevokeRequest": 2,
  "nrOfWhitelistingsThatHadActiveLoginsThatWereRevoked": 1
}