curl --request GET \
--url https://api.unkey.dev/v1/identities.listIdentities \
--header 'Authorization: Bearer <token>'
{
"identities": [
{
"id": "<string>",
"externalId": "<string>",
"ratelimits": [
{
"name": "tokens",
"limit": 10,
"duration": 1000
}
]
}
],
"cursor": "eyJrZXkiOiJrZXlfMTIzNCJ9",
"total": 123
}
List all identities in the system. This will return a paginated list of identities.
Changelog
| Date | Changes |
|---|
| Jul 17 2024 | Introduced endpoint |
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
This is not yet used but here for future compatibility.
The maximum number of identities to return
Required range: 1 <= x <= 100
Use this to fetch the next page of results. A new cursor will be returned in the response if there are more results.
Response
200
A list of identities.
The id of this identity. Used to interact with unkey's API
When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.
identities.ratelimits.name
The name of this limit. You will need to use this again when verifying a key.
identities.ratelimits.limit
How many requests may pass within a given window before requests are rejected.
Required range: x >= 1
identities.ratelimits.duration
The duration for each ratelimit window in milliseconds.
Required range: x >= 1000
The total number of identities for this environment
The cursor to use for the next page of results, if no cursor is returned, there are no more results