Update a role

PUT 
<your-unleash-url>/api/admin/roles/:roleId

Update a custom role by role id

Request

Path Parameters

roleId stringrequired

application/json

Bodyrequired

createRoleWithPermissionsSchema

anyOf
MOD1
namestringrequired
The name of the custom role
Example: external-contributors
descriptionstring
A more detailed description of the custom role and what use it's intended for
Example: Users with external-contributors role have limited access to most features in Unleash
typestring
Custom root roles (type=root-custom) are root roles with a custom set of permissions. Custom project roles (type=custom) contain a specific set of permissions for project resources.
Possible values: [root-custom, custom]
Example: root-custom
permissions object[]
A list of permissions assigned to this role
Array [
namestringrequired
The name of the permission
Example: CREATE_PROJECT
environmentstringnullable
The environments of the permission if the permission is environment specific
Example: development
]
MOD2
namestringrequired
The name of the custom role
Example: external-contributors
descriptionstring
A more detailed description of the custom role and what use it's intended for
Example: Users with external-contributors role have limited access to most features in Unleash
typestring
Custom project roles contain a specific set of permissions for project resources.
Possible values: [custom]
Example: custom
permissions object[]
A list of permissions assigned to this role
Array [
idnumberrequired
The id of the permission
Example: 2
namestring
The name of the permission
Example: CREATE_PROJECT
environmentstringnullable
The environments of the permission if the permission is environment specific
Example: development
]

Responses

200

roleWithVersionSchema

application/json

Schema

Schema

versionintegerrequired
The version of this schema
Possible values: >= 1
Example: 1
roles objectrequired
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
idintegerrequired
The role id
Example: 9
typestringrequired
A role can either be a global root role (applies to all projects) or a project role
Example: root
namestringrequired
The name of the role
Example: Editor
descriptionstring
A more detailed description of the role and what use it's intended for
Example: 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.
projectstringnullable
What project the role belongs to
Example: default

Example (auto)

{
  "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"
  }
}

400

The request data does not match what we expect.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: ValidationError
messagestring
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NameExistsError
messagestring
A description of what went wrong.
Example: There is already a feature called "my-awesome-feature".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "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"
    }
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

roleId — pathrequired

Body required

{
  "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"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!