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.

post

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

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

tenantNamestringRequired

Enter a name for the new tenant (the workspace to be onboarded).

tenantIdstring · uuidRequired

Enter the ID of an existing Power BI workspace.

onboardUserstring · enumRequired

Enum for onboarding user.

Possible values:

versionstringOptional

The requested API version

Default: 1.0

Responses

200

Success: Workspace onboarded successfully as a tenant.

text/plainapplication/jsontext/json

Class for representing response.

messagestring · 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 Message property.

Default: Success Message

statusCodeinteger · int32Optional

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.

Default: 200

409

Conflict: Indicates that the requested workspace may already exist with the same name or ID.

text/plainapplication/jsontext/json

500

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

text/plainapplication/jsontext/json

post

/tenants/onboard

HTTPcURLJavaScriptPython

POST /tenants/onboard?tenantName=text&tenantId=123e4567-e89b-12d3-a456-426614174000&onboardUser=enabled HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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