Get the tenant group by id

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

x-public: "true"

Gets a tenant group by id.

Request

Path Parameters

mssp-id stringrequired

the mssp the managed tenants belong to

id uuidrequired

the id of the tenant group

Responses

200

OK

application/json; charset=UTF-8

Schema

Schema

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

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "string",
  "tenants": [
    {
      "externalTenantId": "string",
      "prismaId": "string"
    }
  ],
  "createdAt": 0,
  "createdBy": "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...