Get Portal Permission By Id

GET 
/v1/portal-permissions/:permission_id

Get portal permission by ID, requires portalPermissions:config:view permission

Request

Path Parameters

permission_id Permission Idrequired

Permission ID in the format ::

Responses

200

Successful Response

application/json

Schema

Schema

permission_id Permission Id (string)required
type Type (string)
scope Scope (string)
access Access (string)
description Description (string)
display_name Display Name (string)
level PermissionAssignmentLevel (string)

Possible values: [glb, org, product, sandbox, environment, product_up, sandbox_up, environment_up]

An enumeration.

Example (from schema)

{
  "permission_id": "string",
  "type": "string",
  "scope": "string",
  "access": "string",
  "description": "string",
  "display_name": "string",
  "level": "glb"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...