You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as
Authorization: Bearer <root key>. See Permission reference for every permission.cursor from one response to get the next page. Calls POST /v2/identities.listIdentities. See Identities.
Usage
Flags
string
Cursor from the previous response.
integer
Maximum number of identities per page. 1 to 100. Defaults to 100.
string
Return only identities whose id or external id contains this text. Not case-sensitive. Up to 256 characters.
Shared flags
Everyunkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then to the key stored by unkey auth login.string
default:"https://api.unkey.com"
Base URL of the API. Falls back to
UNKEY_API_BASE_URL. You don’t normally need to set it.string
default:"~/.unkey/config.toml"
Path of the config file written by
unkey auth login. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.
Required permissions
identity.*.read_identity. A root key with only identity.<identityId>.read_identity fails as soon as the page includes any other identity. See Root key permissions.
Examples
First page
Search
Raw body