Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Tenants

Get tenant details

Returns information about a particular customer's tenant.

get/msp/v3/customers/{customerID}/tenants/{tenantID}

Path parameters

customerIDstring required

Specify the unique ID of a customer in MSP. Get the ID of a customer using the 'List all customers' API.

tenantIDstring required

Specify the unique ID of a tenant in MSP. Get the ID of a tenant using the 'List all tenants' API.

Query parameters

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

idstring

The unique ID of the tenant. Example - 'e293b4c7-a984-4813-8fba-526d5b0edc80'

customerIDstring

The unique ID of the MSP customer. Example - '8ccbc1c-0ca0-4077-ad94-a74479c299b8'

productIDinteger

The ID of the product tenant.

  • For Enterprise Workloads, it is '1'.
  • For SaaS Apps and Endpoints, it is '2'.
licenseExpiryDatestring date-time

The date on which the license of tenant will expire. Example - '2022-10-25T00:00:00Z'

quotanumber double

The quota limit for the tenant. It is a soft limit affecting only quota alerts and reporting. Example - 1.5

quotaEndDatestring date-time

The quota end date for the tenant. Example - '2022-10-25T00:00:00Z'

quotaStartDatestring date-time

The quota start date for the tenant. Example - '2022-10-25T00:00:00Z'

servicePlanIDinteger

The unique ID of the service plan associated with the tenant. Example - 1

editionstring

The product license edition associated with the tenant. The edition can have one of the following values -

  • business
  • enterprise
  • elite
tenantTypeinteger

Specify the tenant type for the product.

  • Specify '1' if it is a Sandbox.
  • Specify '2' if it is Evaluation. This is a trial plan with a validity of 30 days. If you select this tenant type, the product license will be active until 30 days. After 30 days, you must change the tenant type to Commercial.
  • Specify '3' if it is Commercial. For this tenant type, a Enterprise Workloads license is valid for eight years, while a SaaS Apps and Endpoints license is valid for three years.
statusinteger
  • The current status of the tenant.
    • 0 Creation Pending - Creation is pending of the tenant.
    • 1 Ready - The tenant is created and associated with the customer.
    • 2 Suspended - The tenant is suspended.
    • 3 Soft deleted - The deletion of the tenant is initiated.
    • 4 Being migrated - Migration of the tenant is in progress.
    • 5 Updating - Tenant updation in under progress.
createdOnstring date-time

The date and time on which the tenant was created. Example - '2022-10-25T00:00:00Z'

activeSincestring date-time

The date and time since the tenant is active for the customer. Example - '2022-10-25T00:00:00Z'

deleteDatestring date-time

The date and time on which the tenant assigned to the customer will be deleted. If the tenant is not marked for deletion, no value is displayed. Example - '2022-10-25T00:00:00Z'

Example response

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