List permission sets

GET 
/iam/v1/permission_sets

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

Responses

200

Successful response.

application/json

Schema

Schema

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

Example (from schema)

{
  "count": 1,
  "items": [
    {
      "aggregated_permissions": [
        "iam.role.get",
        "iam.role.list",
        "iam.accessPolicy.get",
        "iam.accessPolicy.list",
        "iam.group.create",
        "iam.group.update",
        "iam.group.delete"
      ],
      "children": [
        "iam.access_policy"
      ],
      "description": "Grants all Permissions used on the page \"Identity and Access Management\".",
      "display_name": "Identity and Access Management",
      "name": "iam.management",
      "parent": "common_services",
      "permissions": [
        "iam.role.get",
        "iam.role.list",
        "iam.group.create",
        "iam.group.update",
        "iam.group.delete"
      ]
    }
  ]
}

Loading...