List Identities

Get a paginated list of all identities in your workspace. Returns metadata and rate limit configurations.

Perfect for building management dashboards, auditing configurations, or browsing your identities.

Important
Requires identity.*.read_identity permission

1 min read

post/v2/identities.listIdentities

Request example

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Identities.ListIdentities(ctx, components.V2IdentitiesListIdentitiesRequestBody{
        Limit: unkey.Pointer[int64](50),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2IdentitiesListIdentitiesResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Response

{
  "data": {
    "cursor": "cursor_eyJsYXN0SWQiOiJpZF8wMlpZUjNROU5QOEpNNFg4SFdTS1BXNDNKRiJ9",
    "identities": [
      {
        "externalId": "user_123",
        "id": "id_01H9TQP8NP8JN3X8HWSKPW43JE",
        "meta": {
          "name": "Alice Smith",
          "plan": "premium"
        },
        "ratelimits": [
          {
            "duration": 60000,
            "limit": 1000,
            "name": "requests"
          }
        ]
      },
      {
        "externalId": "user_456",
        "id": "id_02ZYR3Q9NP8JM4X8HWSKPW43JF",
        "meta": {
          "name": "Bob Johnson",
          "plan": "basic"
        },
        "ratelimits": [
          {
            "duration": 60000,
            "limit": 500,
            "name": "requests"
          }
        ]
      }
    ],
    "total": 247
  },
  "meta": {
    "requestId": "req_01H9TQPP77V5E48E9SH0BG0ZQX"
  }
}

post/v2/identities.listIdentities

Authorization

Authorizationstringheaderrequired#

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs.
To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

limitinteger#

The maximum number of identities to return in a single request. Use this to control response size and loading performance.

Default: 100

Range: 1–100

cursorstring#

Pagination cursor from a previous response. Use this to fetch subsequent pages of results when the response contains a cursor value.

searchstring#

Free-form text to filter identities. Returns identities whose ID or external ID contains the search string. Matching is case-insensitive.

Length: max 256

Responses

application/json

Successfully retrieved the list of identities

metaobjectrequired#

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

requestIdstringrequired#

A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.

dataobject[]required#

List of identities matching the specified criteria.

Show child attributes

idstringrequired#

Identity ID

externalIdstringrequired#

External identity ID

metaobject#

Identity metadata

ratelimitsobject[]#

Identity ratelimits

Show child attributes

idstringrequired#

Unique identifier for this rate limit configuration.

Length: 8–255Pattern: ^rl_[a-zA-Z0-9_]+$

namestringrequired#

Human-readable name for this rate limit.

Length: 1–128

limitintegerrequired#

Maximum requests allowed within the time window.

Range: 1–1000000

durationintegerrequired#

Rate limit window duration in milliseconds.

Range: 1000–2592000000

autoApplybooleanrequired#

Whether this rate limit was automatically applied when verifying the key.

paginationobjectrequired#

Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.

Show child attributes

cursorstring#

Opaque pagination token for retrieving the next page of results.
Include this exact value in the cursor field of subsequent requests.
Cursors are temporary and may expire after extended periods.

Length: 1–1024

hasMorebooleanrequired#

Indicates whether additional results exist beyond this page.
When true, use the cursor to fetch the next page.
When false, you have reached the end of the result set.

metaobjectrequired#

Show child attributes

requestIdstringrequired#

errorobjectrequired#

Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.

Show child attributes

detailstringrequired#

A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.

statusintegerrequired#

HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict), and 500 (Internal Server Error).

titlestringrequired#

A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.

typestringrequired#

A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.

errorsobject[]required#

List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.

Show child attributes

locationstringrequired#

JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:

'body.name' (field in request body)
'body.items[3].tags' (nested array element)
'path.apiId' (path parameter)
'query.limit' (query parameter)
Use this location to identify exactly which part of your request needs correction.

messagestringrequired#

Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.

fixstring#

A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.

Get Identity Update Identity