Get Portal Permissions

GET 
/v1/portal-permissions-and-entities

Get Portal Permissions

Responses

200

Successful Response

application/json

Schema

Schema

permissions

object

required

account_id uuidrequired

Account id

is_global_admin Is Global Admin (boolean)required

Is this account a global admin

accountPermissions

object[]

Array [

account_permission_id uuidrequired

Account permission id uniquely identifies this permission assignment

account_id uuidrequired

Account id this permission is assigned to

assigned_org_id uuidrequired

Organization that this permission belongs to

org_id uuid

product_id uuid

sandbox_id uuid

environment_id uuid

permission_id Permission Id (string)required

]

groupPermissions

object[]

Array [

group_id uuidrequired

permissions

object[]

Array [

group_permission_id uuidrequired

group_id uuidrequired

org_id uuid

product_id uuid

sandbox_id uuid

environment_id uuid

permission_id Permission Id (string)required

]

]

menu_data

object

required

selectedEntities

object

required

level Level (string)required

org

object

required

property name* string

environment

object

required

property name* string

sandbox

object

required

property name* string

product

object

required

property name* string

assignedEntities

object

required

orgs

object[]

required

Array [

orgId uuidrequired

orgName Orgname (string)required

shortName Shortname (string)required

products

object[]

required

Array [

productId uuidrequired

productName Productname (string)required

shortName Shortname (string)required

sandboxes

object[]

required

Array [

sandboxId uuidrequired

shortName Shortname (string)required

sandboxName Sandboxname (string)required

archive Archive (boolean)

readonly Readonly (boolean)

]

environments

object[]

required

Array [

environmentId uuidrequired

shortName Shortname (string)required

environmentName Environmentname (string)required

archive Archive (boolean)

baseUrl Baseurl (string)

rhBaseUrl Rhbaseurl (string)required

environmentClassicSupportToolUrl Environmentclassicsupporttoolurl (string)

connectedSandboxId uuid

state State (string)

uniqueName Uniquename (string)

]

archive Archive (boolean)required

uniqueName Uniquename (string)

]

archive Archive (boolean)required

grafanaOrgId Grafanaorgid (integer)

]

Example (from schema)

{
  "permissions": {
    "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_global_admin": true,
    "accountPermissions": [
      {
        "account_permission_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "assigned_org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "permission_id": "string"
      }
    ],
    "groupPermissions": [
      {
        "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "permissions": [
          {
            "group_permission_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "permission_id": "string"
          }
        ]
      }
    ]
  },
  "menu_data": {
    "selectedEntities": {
      "level": "string",
      "org": {},
      "environment": {},
      "sandbox": {},
      "product": {}
    },
    "assignedEntities": {
      "orgs": [
        {
          "orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "orgName": "string",
          "shortName": "string",
          "products": [
            {
              "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "productName": "string",
              "shortName": "string",
              "sandboxes": [
                {
                  "sandboxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "shortName": "string",
                  "sandboxName": "string",
                  "archive": false,
                  "readonly": false
                }
              ],
              "environments": [
                {
                  "environmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "shortName": "string",
                  "environmentName": "string",
                  "archive": false,
                  "baseUrl": "string",
                  "rhBaseUrl": "string",
                  "environmentClassicSupportToolUrl": "string",
                  "connectedSandboxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "state": "string",
                  "uniqueName": "string"
                }
              ],
              "archive": true,
              "uniqueName": "string"
            }
          ],
          "archive": true,
          "grafanaOrgId": 0
        }
      ]
    }
  }
}

Loading...