Tenant - Retrieves available workspaces for onboarding

Retrieves a list of Power BI workspaces available for onboarding as logical tenants.

GET/tenants/onboard/available

Authorization

Bearer

Query parameters

Response

200500

Success: List of available Power BI workspaces retrieved successfully.

Body

text/plainapplication/jsontext/json

tenantIdstring (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the tenantId property.

tenantNamenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the tenantName property.

capacityIdnullable string (uuid)

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the capacityId property.

userCountinteger (int32)

A public property of type Int that has both a getter and a setter method, which allows for getting and setting the value of the UserCount property.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/onboard/available', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200500

[
  {
    "tenantId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantName": "text",
    "capacityId": "123e4567-e89b-12d3-a456-426614174000",
    "userCount": 0
  }
]