Share via

Admin - Datasets GetDatasetUsersAsAdmin

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

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

Permissions

  • The user must be a Fabric administrator or authenticate using a service principal.
  • Delegated permissions are supported.
  • The permissions for this API call are listed in Datasets permissions.

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/datasets/{datasetId}/users

URI Parameters

Name In Required Type Description
datasetId
 path True

string (uuid)

The dataset ID

Responses

Name Type Description
200 OK

DatasetUsers

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/datasets/{datasetId}/users

Sample response

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

Definitions

Name Description
DatasetUser

A Power BI user access right entry for a dataset
DatasetUserAccessRight

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

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

The principal type
ServicePrincipalProfile

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

DatasetUser

Object

A Power BI user access right entry for a dataset

Name Type Description
datasetUserAccessRight

DatasetUserAccessRight

The access right that the user has for the dataset (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.

DatasetUserAccessRight

Enumeration

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

Value Description
None

Removes permission to the content in the dataset
Read

Grants Read access to the content in the dataset
ReadWrite

Grants Read and Write access to the content in the dataset
ReadReshare

Grants Read and Reshare access to the content in the dataset
ReadWriteReshare

Grants Read, Write, and Reshare access to the content in the dataset
ReadExplore

Grants Read and Explore access to the content in the dataset
ReadReshareExplore

Grants Read, Reshare, and Explore access to the content in the dataset
ReadWriteExplore

Grants Read, Write, and Explore access to the content in the dataset
ReadWriteReshareExplore

Grants Read, Write, Reshare, and Explore access to the content in the dataset

DatasetUsers

Object

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

Name Type Description
@odata.context

string

value

DatasetUser[]

The list of users with access to a dataset

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