Jaa


Admin - Groups GetGroupUsersAsAdmin

Returns a list of users that have access to the specified workspace.

Permissions

  • The user must be a Fabric administrator or authenticate using a service principal.
  • Delegated permissions are supported.

When running under service prinicipal authentication, an app must not have any admin-consent required premissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

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

GroupUsers

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

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

GroupUsers

The OData response wrapper for a list of Power BI users with access to a workspace

PrincipalType

The principal type

ServicePrincipalProfile

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

GroupUser

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

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

Name Type Description
Admin

string

Administrator rights to workspace content

Contributor

string

Read and explore (ReadExplore) access to workspace content

Member

string

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

None

string

No access to workspace content

Viewer

string

Read-only (Read) access to workspace content

GroupUsers

The OData response wrapper for a list of Power BI users with access to a workspace

Name Type Description
odata.context

string

value

GroupUser[]

The list of users with access to a workspace

PrincipalType

The principal type

Name Type Description
App

string

Service principal type

Group

string

Group principal type

None

string

No principal type. Use for whole organization level access.

User

string

User principal type

ServicePrincipalProfile

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

The service principal profile ID