Official Libraries
- @unkey/api
- Overview
- Keys
- Analytics
- APIs
- Identities
- Ratelimits
- Migrations
- Permissions
- @unkey/ratelimit
- @unkey/nextjs
- @unkey/hono
- @unkey/cache
- unkey-go
- unkey.py
Community Libraries
- Elixir
- Nuxt
- Rust
- Springboot
Keys
Remove Roles
Remove one or more roles from a key.
Copy
Ask AI
const { result, error } = await unkey.keys.removeRoles({
keyId: "key_123",
roles: [
{
name: "domain.manager",
},
],
});
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result)
Copy
Ask AI
{ "result": {} }
Copy
Ask AI
const { result, error } = await unkey.keys.removeRoles({
keyId: "key_123",
roles: [
{
name: "domain.manager",
},
],
});
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result)
Copy
Ask AI
{ "result": {} }
To use this function, your root key must have the rbac.*.remove_permission_from_key
permission.
Request
The id of the key
Response
result
{}
Was this page helpful?
Copy
Ask AI
const { result, error } = await unkey.keys.removeRoles({
keyId: "key_123",
roles: [
{
name: "domain.manager",
},
],
});
if (error) {
// handle potential network or bad request error
// a link to our docs will be in the `error.docs` field
console.error(error.message);
return;
}
console.log(result)
Copy
Ask AI
{ "result": {} }
Assistant
Responses are generated using AI and may contain mistakes.