Tenant - Retrieves available workspaces for onboarding

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

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Success: List of available Power BI workspaces retrieved successfully.

text/plainapplication/jsontext/json

Class for storing details about tenant to get onboard.

tenantIdstring · uuidOptional

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.

tenantNamestring · nullableOptional

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.

capacityIdstring · uuid · nullableOptional

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 · int32Optional

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.

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/tenants/onboard/available

HTTPcURLJavaScriptPython

GET /tenants/onboard/available HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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