Create a tenant group

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

x-public: "true"

Creates a tenant group if it doesn't exist. Will use msspId from the auth token if available.

Request

Path Parameters

mssp-id stringrequired

the id mssp the tenant group belongs to

application/json; charset=UTF-8

Body

required

groupName stringrequired

Possible values: >= 3 characters and <= 63 characters

tenantIds string[]

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"
}

400

Client error. One of the required arguments in the request body is not correctly supplied

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
    ]
  }
}

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