Roles

Load role by role ID

Changed on

Load role based on the role id with optional children roles

get/api/v1/roles/{roleid}

Request

Path parameters

roleidstring required

Role ID

Query parameters

loadChildrenRolesboolean

Load children roles

Response

Role retrieved successfully

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "childCount": 3,
    "userCount": 12
  }
}

Changes

    • info

      api tag Roles added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status