Tenant - Onboards a workspace as a tenant

Onboards an existing Power BI workspace as a logical tenant, ensuring the service principal has been granted 'Admin' access beforehand.

Please first grant 'Admin' access to the service principal on your workspace

POST/tenants/onboard

Authorization

Bearer

Query parameters

Response

200409500

Success: Workspace onboarded successfully as a tenant.

Body

text/plainapplication/jsontext/json

messagenullable 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 Message property.

statusCodeinteger (int32)

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/onboard?tenantName=text&tenantId=123e4567-e89b-12d3-a456-426614174000&onboardUser=enabled', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200409500

{
  "message": "Success Message",
  "statusCode": 200
}