Skip to navigation

List the tenant's principals

API key required. Returns the tenant’s identity directory — the principals (teams, services, agents) its API keys are issued to — oldest first, each with its live key count. Deleted principals are excluded unless include_deleted=1; they stay resolvable by id forever so old receipts keep their meaning. The first call also lazily migrates the tenant: pre-directory keys are attached to an auto-created “default” principal.

Query parameters

include_deletedstringOptional
Set to 1 to include tombstoned principals.

Response

The tenant's principal directory.

Errors

401
Unauthorized Error