GET
/
v1
/
identities.getIdentity

Identities are in public beta. Please report any issues to support@unkey.dev

Retrieve an identity either by identityId or by externalId.

The response will include the identity as well as its configured rate limits.

Changelog

DateChanges
Jul 17 2024Introduced endpoint

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

identityId
string

The id of the identity to fetch, use either identityId or externalId, if both are provided, identityId takes precedence.

Minimum length: 1
externalId
string

The externalId of the identity to fetch, use either identityId or externalId, if both are provided, identityId takes precedence.

Minimum length: 1

Response

200 - application/json
id
string
required

The id of this identity. Used to interact with unkey's API

externalId
string
required

The id in your system

meta
object
required

The meta object defined for this identity.

ratelimits
object[]
required

When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.