Remove emails from access policy

Remove emails from an access policy; optionally revoke active sessions in the same call.

cURL

curl -X DELETE "$API_BASE_URL/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/policies/$POLICY_ID/emails" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["[e-mail]"],
    "revokeUserEngagement": true
  }'

200

{
  "policyEmails": ["*@external.example.com", "[e-mail]"],
  "removedEmails": [
    {
      "email": "[e-mail]",
      "revokedLoginsForSelfProvisioning": 3,
      "revokedLoginsForMeetingHost": 0,
      "revokedWhitelisting": 0,
      "revokeLoginsforConferences": 1
    }
  ]
}

Removes email addresses or patterns from an access policy and, by default, revokes any active sign-ins the departing emails have made through modules gated by this policy.

Request

organizationId · string · required

Organization ID.

contextId · string · required

Sign-In Context ID.

accessPolicyId · string · required

Access policy UUID.

x-auth-token · string · required

Context API key.

emails · string[] · required

List of email addresses or patterns to remove. Entries that are not in the policy are ignored.

revokeUserEngagement · boolean · default: "true"

When true (default), active sign-ins associated with the removed emails are revoked. Set false to leave existing sessions intact and only prevent future sign-ins.

cURL

curl -X DELETE "$API_BASE_URL/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/policies/$POLICY_ID/emails" \
  -H "x-auth-token: $NETGRAPH_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["[e-mail]"],
    "revokeUserEngagement": true
  }'

Response

policyEmails · string[]

Emails still in the policy after the removal.

removedEmails · object[]

One entry per email that was actually removed, including how many active sign-ins (per module) were revoked.

Show removed-email fields

email · string

The removed email.

revokedLoginsForSelfProvisioning · integer

Self-Provisioning by Email sign-ins terminated.

revokedLoginsForMeetingHost · integer

Meeting Host sign-ins terminated.

revokedWhitelisting · integer

Whitelist-created sign-ins terminated (if the removed email was the whitelist creator).

revokeLoginsforConferences · integer

Conference sign-ins terminated.

200

{
  "policyEmails": ["*@external.example.com", "[e-mail]"],
  "removedEmails": [
    {
      "email": "[e-mail]",
      "revokedLoginsForSelfProvisioning": 3,
      "revokedLoginsForMeetingHost": 0,
      "revokedWhitelisting": 0,
      "revokeLoginsforConferences": 1
    }
  ]
}