Policy User Scope Update API

Update a policy user scope

Update a policy user scope, define inclusion/exclusion rule for users using user emails. Only supports Google Drive policies, separates internal or external users based on google domains registered in Nightfall. You can use this endpoint with Nightfall Sensitive Data Protction, Exfiltration Prevention, and Data Security Posture Management.

POSThttps://api.nightfall.ai/policy/v1/{policyID}/scope/users

Authorization

bearerAuth

Path parameters

policyID*string (uuid)

The UUID of the policy to update

Body

application/json

addobject

deleteobject

Response

200400401403404429500

Successful response (processed immediately)

Headers

Body

application/json

includedUsersarray of string

a list of all included user identifiers (emails or id's) in the policy

excludedUsersarray of string

a list of all excluded user identifiers (emails or id's) in the policy

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.nightfall.ai/policy/v1/{policyID}/scope/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "add": {
        "include": [
          null
        ],
        "exclude": [
          null
        ]
      },
      "delete": {
        "include": [
          null
        ],
        "exclude": [
          null
        ]
      }
    }),
});
const data = await response.json();

Response

200400401403404429500

{
  "includedUsers": [
    "text"
  ],
  "excludedUsers": [
    "text"
  ]
}