GIgitguardian
NHI Policies

Set the incident mode of an NHI policy

Changed on

Set the incident mode of an NHI policy for the workspace.

Incidents are created only once NHI incident promotion is active for the workspace. Before that, the mode is stored and no incident is created.

When a policy starts to create incidents, only the breaches recorded after that point create incidents. The breaches recorded before, and the breaches recorded while promotion was not active, do not.

When a policy goes to or from hidden, GitGuardian checks the policy again for the workspace.

The workspace must have full NHI governance activation. The API token must have the Manager access level or above, or be a service account token.

put/v1/nhi/policies/{policy_name}

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/nhi/policies/{policy_name}
  • Auth
    HTTP bearer

Path parameters

policy_namestring required

The name of the NHI policy, for example long_lived_secret.

Request body

incident_mode'hidden' | 'tag_only' | 'creates_incidents' required
  • hidden: the breaches are not shown.
  • tag_only: the breaches show as a tag on the identity.
  • creates_incidents: the breaches also create secret incidents.

Response

The policy, with its new mode.

namestring required
incident_mode'hidden' | 'tag_only' | 'creates_incidents' required
  • hidden: the breaches are not shown.
  • tag_only: the breaches show as a tag on the identity.
  • creates_incidents: the breaches also create secret incidents.
is_incident_mode_fixedboolean required

Whether the incident mode of this policy is fixed and cannot be changed.

Example response

{
  "name": "long_lived_secret"
}

Changes