Set Permissions
Overwrite the permissions of a key with a new set of permissions.
Sets the permissions of a key to a new set of permissions. This endpoint overwrites the existing permissions of the key with the new set. Existing permissions that are not included in the new set are removed.
You can provide either permission ids or permission names in the request body. If you provide a name, we will create the permission if it does not exist.
To use this endpoint, your root key must have the rbac.*.add_permission_to_key and potentially the rbac.*.create_permission permissions.
Changelog
| Date | Changes |
|---|---|
| Jul 08 2024 | Introduced endpoint |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The id of the key.
The permissions you want to set for this key. This overwrites all existing permissions.
Setting permissions requires the rbac.*.add_permission_to_key permission.
Response
The id of the permission. This is used internally
The name of the permission
Was this page helpful?