Get an identity
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
Date | Changes |
---|---|
Jul 17 2024 | Introduced endpoint |
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The id of the identity to fetch, use either identityId
or externalId
, if both are provided, identityId
takes precedence.
The externalId of the identity to fetch, use either identityId
or externalId
, if both are provided, identityId
takes precedence.
Response
The id of this identity. Used to interact with unkey's API
The id in your system
The meta object defined for this identity.
When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.
Was this page helpful?