Get the details of an existing policy group

GET 
/api/v1/mssp/:mssp-id/policy-group/:pg-id

x-public: "true"

Returns the details of an existing policy group. Will use msspId from the auth token if available.

Request

Path Parameters

pg-id uuidrequired
the id of the policy group
Example: 34e2e197-f172-4a04-93a4-39b1532648ab
mssp-id stringrequired
the mssp the policy group belongs to
Example: e91b486a-e139-4d3b-a9dd-959fd5cffb10

Responses

200

OK

application/json; charset=UTF-8

Schema

Schema

id uuid
name string
policies string[]
tenantGroups object[]
Array [
id uuid
tenantGroupId uuid
tenantGroupName string
tenantCount int32
]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "policies": [
    "string"
  ],
  "tenantGroups": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantGroupName": "string",
      "tenantCount": 0
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error objectrequired
code stringrequired
message stringrequired
target string
details undefined[]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error objectrequired
code stringrequired
message stringrequired
target string
details undefined[]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

403

Forbidden

application/json

Schema

Schema

error objectrequired
code stringrequired
message stringrequired
target string
details undefined[]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

429

Too Many Requests

application/json

Schema

Schema

error objectrequired
code stringrequired
message stringrequired
target string
details undefined[]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

Loading...