Share via

Admin - Groups AddUserAsAdmin

Service:
Power BI REST APIs
API Version:
v1.0

Grants user permissions to the specified workspace.

This API call only supports adding a user, security group, M365 group and service principal.

Permissions

The user must be a Fabric administrator.

Required Scope

Tenant.ReadWrite.All

Limitations

  • Maximum 200 requests per hour.
  • Each workspace is limited to a maximum of 1,000 users or groups in workspace roles (Admin, Member, Contributor, Viewer). The number of users within a group is not limited. The limitation also covers external guests. 

POST https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/users

URI Parameters

Name In Required Type Description
groupId
 path True

string (uuid)

The workspace ID

Request Body

Name Required Type Description
groupUserAccessRight True

GroupUserAccessRight

The access right (permission level) that a user has on the workspace
identifier True

string

Identifier of the principal
principalType True

PrincipalType

The principal type
displayName

string

Display name of the principal
emailAddress

string

Email address of the user
graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.
profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
userType

string

Type of the user.

Responses

Name Type Description
200 OK

OK

Examples

Add security group to workspace example
Add service principal to workspace example
Add user to group example

Add security group to workspace example

Sample request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users
Request Body
{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Sample response

Status code:
200

Add service principal to workspace example

Sample request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users
Request Body
{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Sample response

Status code:
200

Add user to group example

Sample request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users
Request Body
{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Sample response

Status code:
200

Definitions

Name Description
GroupUser

A Power BI user with access to the workspace
GroupUserAccessRight

The access right (permission level) that a user has on the workspace
PrincipalType

The principal type
ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

GroupUser

Object

A Power BI user with access to the workspace

Name Type Description
displayName

string

Display name of the principal
emailAddress

string

Email address of the user
graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.
groupUserAccessRight

GroupUserAccessRight

The access right (permission level) that a user has on the workspace
identifier

string

Identifier of the principal
principalType

PrincipalType

The principal type
profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
userType

string

Type of the user.

GroupUserAccessRight

Enumeration

The access right (permission level) that a user has on the workspace

Value Description
None

No access to workspace content
Member

Read, reshare and explore (ReadReshareExplore) access rights to workspace content
Admin

Administrator rights to workspace content
Contributor

Read and explore (ReadExplore) access to workspace content
Viewer

Read-only (Read) access to workspace content

PrincipalType

Enumeration

The principal type

Value Description
None

No principal type. Use for whole organization level access.
User

User principal type
Group

Group principal type
App

Service principal type

ServicePrincipalProfile

Object

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName

string

The service principal profile name
id

string (uuid)

The service principal profile ID