USusekaneo
Admin

Update a custom instance role

Changed on

Rename a role or replace its permissions. Users who have it keep it under the new name, and permission changes apply to their next request. Requires the roles:manage permission; API keys are rejected.

put/admin/roles/{roleId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/admin/roles/{roleId}
  • Auth
    HTTP bearer

Path parameters

roleIdstring required

Request body

namestring required

Lowercase letters, digits and hyphens, starting with a letter. admin and user are reserved.

permissionsstring[] required

Instance permissions the role grants. roles:manage belongs to the built-in admin role only.

Example request

{
  "name": "support"
}

Response

The updated role

idstring required
namestring required
permissionsstring[] required
userCountinteger required

Users who currently have this role.

createdAtstring date-time required
updatedAtstring date-time required

Changes