Get a Custom Role

GET 
/iam/v1/custom_roles/:name

Gets the details of a single instance of a custom_role.

Request

Path Parameters

name _idrequired

Possible values: >= 10 characters and <= 10 characters, Value must match regular expression ^^1[0-9]*$

A unique identifier for a custom_role.

Responses

200

Successful response - returns a single custom_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 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.

Example (from schema)

{
  "aggregated_permissions": [
    "prisma_access.config.get",
    "iam.service_account.create",
    "iam.access_policy.create"
  ],
  "description": "Access to Log Viewer endpoints",
  "id": "log_viewer:1234567890",
  "label": "Log Viewer",
  "name": "log_viewer",
  "permission_sets": [
    {
      "access_types": [
        "read"
      ],
      "id": "prisma_access.config"
    }
  ],
  "permissions": [
    "iam.service_account.create",
    "iam.access_policy.create"
  ],
  "tsg_id": "1234567890"
}

Loading...