GIgitguardian
NHI Identities

Get the validity of an identity

Changed on

Retrieve the validity of the secret an identity holds, and its validity override. validity_override is null when no override is set.

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

get/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

Response

The validity of the identity.

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