Skip to main content

List permission sets



List all permission sets. Permission sets are used when defining custom roles for user access to the UI.


Successful response.

    count integerrequired

    Default value: 1

    Total count of the items

    items object[]required
  • Array [
  • aggregated_permissions array

    Identifies all of the permissions in the permission set, as well as all the permissions defined for the current TSG's child TSGs.

    children array

    All of the child permission sets contained in the parent permission set.

    description required

    Descriptive text displayed by the UI.

    display_name stringrequired

    Label used in the UI to identify the permission set.

    name stringrequired

    Permission set's unique identifier. Used in API calls to identify this permission set.

    parent string

    Name of the permission set's parent.

    permissions array

    All permissions contained by the permission set.

  • ]