Get a details of the role whose role id has been provided

Path Parameters

roleId int32 required
Role Id

Query Parameters

showInheritedAssociation boolean
Shows inherited security associations

Responses

Success

application/json

Schema
Example (from schema)

Schema

id int32
id of the role.
name string
name of the role.
permissions object[]
List of permissions associated with the role.
permission object
id int32
name string
category object
id int32
name string
visibleToAll boolean
Returns if the role is visible to all.
status string
Possible values: [ENABLED, DISABLED]
Specifies whether the role has been enabled or disabled.
security object[]
Used to return the security association for the role
user object
id int32
name string
userGroup object
id int32
name string
externalUserGroup object
External User Group Entity
id int32
User Group Id
name string
External Group Name
providerId int32
Provider id
providerName string
Provider Name
isCreatorAssociation boolean
role object
id int32
name string
permissionList object[]
permissionId int32
permissionName string
categoryId int32
categoryName string
type string
Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]
Returns the type of association.
exclude boolean
Flag to specify if this is included permission or excluded permission.

{
  "id": 0,
  "name": "string",
  "permissions": [
    {
      "permission": {
        "id": 0,
        "name": "string"
      },
      "category": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "visibleToAll": true,
  "status": "ENABLED",
  "security": [
    {
      "user": {
        "id": 0,
        "name": "string"
      },
      "userGroup": {
        "id": 0,
        "name": "string"
      },
      "externalUserGroup": {
        "id": 0,
        "name": "string",
        "providerId": 0,
        "providerName": "string"
      },
      "isCreatorAssociation": true,
      "role": {
        "id": 0,
        "name": "string"
      },
      "permissionList": [
        {
          "permissionId": 0,
          "permissionName": "string",
          "categoryId": 0,
          "categoryName": "string",
          "type": "ALL_CATEGORIES",
          "exclude": true
        }
      ]
    }
  ]
}

Get a details of the role whose role id has been provided​

Get a details of the role whose role id has been provided