Admin - Groups AddUserAsAdmin

Grants user permissions to the specified workspace.
Note: This API is currently limited to updating workspaces in the new workspace experience and adding user principle only. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.

Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

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

Access rights user has for the workspace

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

identifier
  • string

Object ID of the principal

principalType

The principal type

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

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

Sample Response

Definitions

GroupUser

A Power BI user access right entry for workspace

GroupUserAccessRight

Access rights user has for the workspace

PrincipalType

The principal type

GroupUser

A Power BI user access right entry for workspace

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

groupUserAccessRight

Access rights user has for the workspace

identifier
  • string

Object ID of the principal

principalType

The principal type

GroupUserAccessRight

Access rights user has for the workspace

Name Type Description
Admin
  • string

Grants administrator rights to workspace

Contributor
  • string

Grants Read and Explore access to content in group

Member
  • string

Grants Read, Reshare and Explore access to content in workspace

None
  • string

Removes permission to content in workspace

Viewer
  • string

Grants Read only access to content in group

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

User
  • string

User principal type