Get a role

GET 
/iam/v1/roles/:name

Get a specified role.

Request

Path Parameters

name stringrequired

Role Name

Responses

200

Successful response - returns a single role.

application/json

Schema

Schema

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 its child TSGs.

description string
label stringrequired

The text displayed in the user interface for this role.

name string

The role name.

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

Example (from schema)

{
  "aggregated_permissions": [
    "prisma_access.config.get",
    "iam.service_account.create",
    "iam.access_policy.create"
  ],
  "app_id": "app_id",
  "description": "Full access to all functions.",
  "label": "Superuser",
  "name": "superuser",
  "permission_sets": [
    {
      "access_type": "read",
      "id": "prisma_access.config"
    }
  ],
  "permissions": [
    "iam.service_account.create",
    "iam.access_policy.create"
  ]
}

Loading...