Policy User Scope Update API

Note

Internal only endpoint. This will change once Nightfall introduces CRUD API's for policies.

Update a policy user scope

Update a policy user scope, define inclusion/exclusion rule for users using user emails. Only supports gDrive policies, separates internal or external users based on google domains registered in Nightfall.

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

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

JavaScriptCurlPython

const response = await fetch('https://api.nightfall.ai/policy/v1/{policyID}/scope/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404429500

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