Skip to main content
GET
List NHI identities

Authorizations

X-API-Key
string
header
required

Domain-scoped API key. Generate and manage keys from the API Keys page in Settings.

Accepted in two forms:

  • X-API-Key: <key> header (preferred)
  • Authorization: Bearer <key> header (also accepted)

Query Parameters

Filter by display name, principal id, or app id.

nhi_class
string

Comma-separated identity classes.

archetype
string
provider
string

Comma-separated platform family keys or labels.

status
enum<string>
default:active
Available options:
active,
dormant,
all
has_persona
boolean

When true, only identities with a Persona L row. When false, only the rest of the fleet.

page_size
integer
default:50
Required range: x <= 200
next_cursor
string<uuid>

nuid of the last item from the previous page.

Response

Paginated NHI directory rows

next_cursor
string | null
items
object[]