Keys
Add Roles
Add one or more roles to a key.
POST
/
v1
/
keys.addRoles
Adds roles to a key. Existing roles are not removed.
To use this endpoint, your root key must have the rbac.*.add_role_to_key and potentially the rbac.*.create_role permissions.
Changelog
| Date | Changes |
|---|---|
| Jul 08 2024 | Introduced endpoint |
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
keyId
string
requiredThe id of the key.
Minimum length:
1roles
object[]
requiredThe roles you want to set for this key. This overwrites all existing roles.
Setting roles requires the rbac.*.add_role_to_key permission.
Response
200 - application/json
id
string
requiredThe id of the role. This is used internally
name
string
requiredThe name of the role
Was this page helpful?