Get a single role

GET 
/api/v2/users/roles/:roleName

Returns a role with its composite child roles (if any).

Request

Path Parameters

roleName stringrequired

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...