Update a role

PUT

https://app.unleash-instance.example.com/api/admin/roles/:roleId

PUT

/api/admin/roles/:roleId

1 import requests
2 
3 url = "https://app.unleash-instance.example.com/api/admin/roles/roleId"
4 
5 payload = { "name": "external-contributors" }
6 headers = {
7     "Authorization": "<apiKey>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.put(url, json=payload, headers=headers)
12 
13 print(response.json())

Try it

1 {
2   "version": 1,
3   "roles": {
4     "id": 9,
5     "type": "root",
6     "name": "Editor",
7     "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.",
8     "project": "default"
9   }
10 }

Enterprise feature

Update a custom role by role id

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

roleIdstringRequired

Request

createRoleWithPermissionsSchema

CreateRoleWithPermissionsSchema0objectRequired

CreateRoleWithPermissionsSchema1objectRequired

Response

roleWithVersionSchema

versioninteger>=1

The version of this schema

rolesobject

A single role

Authentication

Path parameters

Request

Response

Errors