Skip to main content

List custom roles



Retrieve all custom roles currently available to the tenant service group identified by the access token used to authorize this request.


Successful response.

    count integerrequired

    Default value: 1

    Total count of the items

    items object[]required
  • Array [
  • aggregated_permissions string[]

    Identifies all permissions available to this TSG. This is a union of the permissions available to the TSG, as well as the permissions available to all its child TSGs.

    description string
    label string
    name string

    The custom role's name. It is used as a path parameter for some custom role APIs.

    permission_sets object[]
  • Array [
  • access_types string[]

    The type of access (read and/or write) granted for this permission set.

    id string

    The ID of a permission set included in this custom role.

  • ]
  • permissions string[]

    The permissions granted to this custom role.

    tsg_id string

    The tenant service group for which this role was created.

  • ]