Get the tenant group list for an MSSP

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

Gets the list of tenant groups for an MSSP. Will use msspId from the auth token if available.

Request

Path Parameters

mssp-id stringrequired

the mssp the managed tenants belong to

Query Parameters

next_page_token string

pagination token to continue a previous queryif set

Responses

200

OK

application/json; charset=UTF-8

Schema

Schema

value object[]
Array [
id uuid
groupName string
tenants object[]
Array [
externalTenantId string
prismaId string
]
createdAt int64
createdBy string
]
nextPageToken string

Example (from schema)

{
  "value": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "groupName": "string",
      "tenants": [
        {
          "externalTenantId": "string",
          "prismaId": "string"
        }
      ],
      "createdAt": 0,
      "createdBy": "string"
    }
  ],
  "nextPageToken": "string"
}

404

The MSSP does not exist

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

Rate limiting error

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