USusekaneo
Admin

Create a custom instance role

Changed on

Create a role that grants a set of instance permissions. Assign it to users by name. Requires the roles:manage permission, which only the built-in admin role has; API keys are rejected.

post/admin/roles

Request

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

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 new role

idstring required
namestring required
permissionsstring[] required
userCountinteger required

Users who currently have this role.

createdAtstring date-time required
updatedAtstring date-time required

Changes