Workspace - Adds a user to a workspace

Adds a user to a Power BI workspace with the specified access level based on the provided details.

POST/tenants/{tenantId}/pbiUsers

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Enter the ID of an existing tenant

Query parameters

Body

application/jsontext/jsonapplication/*+json

"UserIdentifier": Email Id of user in case of User or object Id in case of service principle or group
"GroupUserAccessRightEnum": Should be Member/Admin/Contributor/Viewer
"PrincipalTypeEnum": Should be User/App/Group

userIdentifiernullable 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 UserIdentifier property.

groupUserAccessRightenum

Enum for group user access right.

NoneMemberAdminContributorViewer

principalTypeenum

Enum for principal type.

NoneUserGroupApp

Response

200404500

Success: User successfully added to the workspace.

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/{tenantId}/pbiUsers', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404500

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