Update a composite role

PUT 
/api/v2/users/roles/:roleName

Updates a composite role name, description and/or its child roles. When childRoles is provided it replaces the current set.

Request

Path Parameters

roleName stringrequired

application/json

Body

required

name string

New name for the composite role

description string

New description for the role

childRoles string[]

Full desired set of child role names. Replaces the current children.

Responses

200

application/json

Schema

Schema

id string
name stringrequired
description string
composite booleanrequired

Whether this role is composite (groups other roles)

childRoles string[]

Child role names grouped by this composite role

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "composite": true,
  "childRoles": [
    "string"
  ]
}

Loading...