Share via

Admin - Dashboards GetDashboardUsersAsAdmin

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

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

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/dashboards/{dashboardId}/users

URI Parameters

Name In Required Type Description
dashboardId
 path True

string (uuid)

The dashboard ID

Responses

Name Type Description
200 OK

DashboardUsers

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/users

Sample response

Status code:
200 
{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "dashboardUserAccessRight": "Owner",
      "identifier": "john@contoso.com",
      "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
      "principalType": "User"
    }
  ]
}

Definitions

Name Description
DashboardUser

A Power BI user access right entry for a dashboard
DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)
DashboardUsers

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

The principal type
ServicePrincipalProfile

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

DashboardUser

Object

A Power BI user access right entry for a dashboard

Name Type Description
dashboardUserAccessRight

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)
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.
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.

DashboardUserAccessRight

Enumeration

The access right that the user has for the dashboard (permission level)

Value Description
None

No permission to content in dashboard
Read

Grants Read access to content in dashboard
ReadWrite

Grants Read and Write access to content in dashboard
ReadReshare

Grants Read and Reshare access to content in dashboard
ReadCopy

Grants Read and Copy access to content in dashboard
Owner

Grants Read, Write and Reshare access to content in report

DashboardUsers

Object

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

Name Type Description
@odata.context

string

value

DashboardUser[]

The list of users with access to a dashboard

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