Update an identity
Identities are in public beta. Please report any issues to support@unkey.dev
Update an identity’s metadata or limits.
Changelog
Date | Changes |
---|---|
Jul 17 2024 | Introduced endpoint |
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The id of the identity to update, use either identityId
or externalId
, if both are provided, identityId
takes precedence.
The externalId of the identity to update, use either identityId
or externalId
, if both are provided, identityId
takes precedence.
This is not yet used but here for future compatibility.
Attach metadata to this identity that you need to have access to when verifying a key.
Set to {}
to clear.
This will be returned as part of the verifyKey
response.
Attach ratelimits to this identity.
This overwrites all existing ratelimits on this identity. Setting an empty array will delete all existing ratelimits.
When verifying keys, you can specify which limits you want to use and all keys attached to this identity, will share the limits.
Response
The id of the identity.
The externalId of the identity.
The metadata attached to this identity.
Was this page helpful?