GIgitguardian
NHI Identities

Override the validity of an identity

Changed on

Set the validity of the secret an identity holds with your own check result.

The override applies to every copy of the secret. It stays until you remove it: the checks that ggscout sends and the validity checks of GitGuardian do not change it. A new copy of the same secret gets the override too. A rotated secret is a different value, so the override does not apply to it.

Incidents keep their own validity. To override the validity of an incident, use Override the validity of a secret.

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

post/v1/nhi/identities/{identity_id}/validity

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/nhi/identities/{identity_id}/validity
  • Auth
    HTTP bearer

Path parameters

identity_idinteger required

The id of the non-human identity

Request body

validity'valid' | 'invalid' | 'failed_to_check' required

Response

The override was set.

identity_idinteger required
validity'valid' | 'invalid' | 'failed_to_check' | 'no_checker' | 'unknown' nullable required

The validity of the identity, the override included. null when the identity holds no secret.

validity_override'valid' | 'invalid' | 'failed_to_check' | 'null' nullable required

The validity override, or null when no override is set.

Example response

{
  "identity_id": 1234,
  "validity": "invalid",
  "validity_override": "invalid"
}

Changes