v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Users

Update a role

Enterprise feature

Update a custom role by role id

put/api/admin/roles/{roleId}

Path parameters

roleIdstring required

Request body

OR

Example request

{
  "name": "external-contributors",
  "description": "Users with external-contributors role have limited access to most features in Unleash",
  "type": "root-custom",
  "permissions": [
    {
      "name": "CREATE_PROJECT",
      "environment": "development"
    }
  ]
}

Response

roleWithVersionSchema

versioninteger required

The version of this schema

Example response

{
  "version": 1,
  "roles": {
    "id": 9,
    "type": "root",
    "name": "Editor",
    "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
    "project": "default"
  }
}