You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as
Authorization: Bearer <root key>. See Permission reference for every permission.--meta and --ratelimits each replace the whole existing value, so pass everything you want to keep. Changes can take up to about 10 seconds to reach verifications. Calls POST /v2/identities.updateIdentity. See Identities.
Usage
Flags
string
required
Identity id or external id.
string
JSON object that replaces the identity’s metadata.
string
JSON array that replaces the identity’s rate limits.
Shared flags
Everyunkey api command takes these. See CLI output and shared flags.
string
Root key used for the request. Falls back to
UNKEY_ROOT_KEY, then to the key stored by unkey auth login.string
default:"https://api.unkey.com"
Base URL of the API. Falls back to
UNKEY_API_BASE_URL. You don’t normally need to set it.string
default:"~/.unkey/config.toml"
Path of the config file written by
unkey auth login. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.
Required permissions
identity.*.update_identity. Without the permission you get a 404, not a 403, so the response doesn’t reveal whether the identity exists. See Root key permissions.
Examples
Replace metadata
Raw body