Skip to main content

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

Select

SaaS
Customer Managed

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

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
  • type string

    Type of permission assigned to the role.

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

  • globalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
Loading...