Get the details of all existing policy groups

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

x-public: "true"

Returns the details of all existing policy groups. Will use msspId from the auth token if available.

Request

Path Parameters

mssp-id stringrequired
the mssp the policy group belongs to
Example: e91b486a-e139-4d3b-a9dd-959fd5cffb10

Query Parameters

next_page_token string

pagination token to continue a previous query

Responses

200

OK

application/json; charset=UTF-8

Schema

Schema

value object[]
Array [
id uuid
name string
policyCount int32
tenantGroupCount int32
]
nextPageToken string

Example (from schema)

{
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "policyCount": 0,
      "tenantGroupCount": 0
    }
  ],
  "nextPageToken": "string"
}

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