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

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Body

application/jsontext/jsonapplication/*+json

Class for storing workspace role assignment details.

userIdentifierstring · 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 UserIdentifier property.

groupUserAccessRightstring · enumOptional

Enum for group user access right.

Possible values:

principalTypestring · enumOptional

Enum for principal type.

Possible values:

Responses

200

Success: User successfully added to the workspace.

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

404

Not Found: Indicates that the requested tenant does not exist.

text/plainapplication/jsontext/json

500

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

text/plainapplication/jsontext/json

post

/tenants/{tenantId}/pbiUsers

HTTPcURLJavaScriptPython

POST /tenants/{tenantId}/pbiUsers HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "userIdentifier": "text",
  "groupUserAccessRight": "None",
  "principalType": "None"
}

application/jsontext/jsonapplication/*+json

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