Policy Update APIs

Update a policy user scope

post

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.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIDstring · uuidRequired

The UUID of the policy to update

Body

application/json

Responses

200

Successful response (processed immediately)

application/json

400

Invalid request parameters

application/json

401

Authentication failure

application/json

403

Operation prohibited on the policy

application/json

404

Policy not found

application/json

429

Rate Limit Exceeded or Daily Quota Exceeded

application/json

500

Internal Nightfall Error

application/json

post

/{policyID}/scope/users

HTTPcURLJavaScriptPython

POST /policy/v1/{policyID}/scope/users HTTP/1.1
Host: api.nightfall.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "add": {
    "include": [
      "[email protected]"
    ],
    "exclude": [
      "[email protected]"
    ]
  },
  "delete": {
    "include": [
      "[email protected]"
    ],
    "exclude": [
      "[email protected]"
    ]
  }
}

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

Update a policy domain scope

post

Update a policy domain scope, define inclusion/exclusion rule for domains. Only supports gDrive policies.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIDstring · uuidRequired

The UUID of the policy to update

Body

application/json

Responses

200

Successful response (processed immediately)

application/json

400

Invalid request parameters

application/json

401

Authentication failure

application/json

403

Operation prohibited on the policy

application/json

404

Policy not found

application/json

429

Rate Limit Exceeded or Daily Quota Exceeded

application/json

500

Internal Nightfall Error

application/json

post

/{policyID}/scope/domains

HTTPcURLJavaScriptPython

POST /policy/v1/{policyID}/scope/domains HTTP/1.1
Host: api.nightfall.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "add": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "delete": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  }
}

{
  "includedDomains": [
    "text"
  ],
  "excludedDomains": [
    "text"
  ]
}

Update a posture policy trigger user scope

post

Update trigger-scoped users for a posture management policy. Modifies users stored in implementation_metadata (trigger scope) rather than the standard user_and_group_in_ex_setting. Only supports posture management policies of gDrive.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIDstring · uuidRequired

The UUID of the policy to update

Body

application/json

Responses

200

Successful response (processed immediately)

application/json

400

Invalid request parameters

application/json

401

Authentication failure

application/json

403

Operation prohibited on the policy

application/json

404

Policy not found

application/json

429

Rate Limit Exceeded or Daily Quota Exceeded

application/json

500

Internal Nightfall Error

application/json

post

/{policyID}/trigger/users

HTTPcURLJavaScriptPython

POST /policy/v1/{policyID}/trigger/users HTTP/1.1
Host: api.nightfall.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "add": {
    "include": [
      "[email protected]"
    ],
    "exclude": [
      "[email protected]"
    ]
  },
  "delete": {
    "include": [
      "[email protected]"
    ],
    "exclude": [
      "[email protected]"
    ]
  }
}

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

Update a posture policy trigger domain scope

post

Update trigger-scoped domains for a posture management policy. Modifies domains stored in implementation_metadata (trigger scope) rather than the standard user_and_group_in_ex_setting. Only supports posture management policies of gDrive.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIDstring · uuidRequired

The UUID of the policy to update

Body

application/json

Responses

200

Successful response (processed immediately)

application/json

400

Invalid request parameters

application/json

401

Authentication failure

application/json

403

Operation prohibited on the policy

application/json

404

Policy not found

application/json

429

Rate Limit Exceeded or Daily Quota Exceeded

application/json

500

Internal Nightfall Error

application/json

post

/{policyID}/trigger/domains

HTTPcURLJavaScriptPython

POST /policy/v1/{policyID}/trigger/domains HTTP/1.1
Host: api.nightfall.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "add": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  },
  "delete": {
    "include": [
      "text"
    ],
    "exclude": [
      "text"
    ]
  }
}

{
  "includedDomains": [
    "text"
  ],
  "excludedDomains": [
    "text"
  ]
}