Get a permission set

GET 
/iam/v1/permission_sets/:name

Retrieve the details for a specific permission set.

Request

Path Parameters

name anyrequired

A unique identifier for a permission_set.

Responses

200

Successful response - returns a single permission_set.

application/json

Schema

Schema

aggregated_permissions undefined[]

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

children undefined[]

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 undefined[]

All permissions contained by the permission set.

Example (from schema)

{
  "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...