Admin - Groups GetGroupUsersAsAdmin

Returns a list of users that have access to the specified workspace. This is a preview API call.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

GET 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

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Sample Response

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin",
      "identifier": "john@contoso.com",
      "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
      "principalType": "User"
    },
    {
      "displayName": "Adam Wood",
      "emailAddress": "Adam@contoso.com",
      "groupUserAccessRight": "Member",
      "identifier": "Adam@contoso.com",
      "graphId": "785e192c-0f1f-41ca-ae7a-a85da28e565a",
      "principalType": "User"
    },
    {
      "displayName": "ContosoTestApp",
      "groupUserAccessRight": "Admin",
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "graphId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App"
    }
  ]
}

Definitions

GroupUser

A Power BI user access right entry for workspace

GroupUserAccessRight

Access rights user has for the workspace (Permission level)

GroupUsers

Odata response wrapper for a Power BI user access right for group List

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

graphId
  • string

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

groupUserAccessRight

Access rights user has for the workspace (Permission level)

identifier
  • string

Object ID of the principal

principalType

The principal type

GroupUserAccessRight

Access rights user has for the workspace (Permission level)

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

GroupUsers

Odata response wrapper for a Power BI user access right for group List

Name Type Description
odata.context
  • string
value

The user access right for group List

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

User
  • string

User principal type