Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Tenants

Get tenants list

Returns list of tenants.

get/msp/v3/tenants

Query parameters

pageTokenstring

Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.

customerIdsstring

Specify the unique customer id for which you want to retrieve the tenant information.

pageSizestring

Specify the number of records you wish to receive in API response. Example - 30. Maximum allowed 'pageSize' value is 100.

includeFeaturesboolean

Specify whether you wish to receive the features list in the API response. Example - true. Default 'includeFeatures' value is false.

Headers

Authorizationstring required

Specify the Bearer access token

Response

Ok

nextPageTokenstring

The token to access the next page of results. This is empty if there are no more results. Example - 'eyJwYWdlU2l6ZSI6IDEwMH0='

Example response

{
  "tenants": [
    {
      "id": "e293b4c7-a984-4813-8fba-526d5b0edc80",
      "customerID": "78ccbc1c-0ca0-4077-ad94-a74479c299b8",
      "productID": 1,
      "licenseExpiryDate": "2022-10-25T00:00:00Z",
      "quota": 1.5,
      "quotaEndDate": "2022-10-25T00:00:00Z",
      "quotaStartDate": "2022-10-25T00:00:00Z",
      "servicePlanID": 1,
      "edition": "enterprise",
      "storageRegions": [
        {
          "name": "us-east-1",
          "storageProvider": 1
        }
      ],
      "features": [
        {
          "name": "M365",
          "attrs": [
            {
              "name": "userCount"
            }
          ]
        }
      ],
      "tenantType": 2,
      "status": 1,
      "createdOn": "2022-10-25T00:00:00Z",
      "activeSince": "2022-10-25T00:00:00Z",
      "deleteDate": "2022-10-25T00:00:00Z"
    }
  ],
  "nextPageToken": "eyJwYWdlU2l6ZSI6IDEwMH0="
}