Datasets - Get Dataset Users

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

When user permissions to a dataset have been recently updated, the new permissions might not be immediately available through API calls. To refresh user permissions, use the Refresh User Permissions API call.

Permissions

The permissions for this API call are listed in Datasets permissions.

Required Scope

Dataset.Read.All or Dataset.ReadWrite.All

Limitations

Caller must have ReadWriteReshare permissions on the dataset. That is, folder admins, members and contributors with Reshare permissions, or dataset owners.

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

URI Parameters

Name In Required Type Description
datasetId
path True

string

The dataset ID

Responses

Name Type Description
200 OK

DatasetUsersAccess

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/users

Sample response

{
  "value": [
    {
      "identifier": "john@contoso.com",
      "principalType": "User",
      "datasetUserAccessRight": "Read"
    },
    {
      "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
      "principalType": "Group",
      "datasetUserAccessRight": "ReadReshare"
    },
    {
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App",
      "datasetUserAccessRight": "ReadWriteReshareExplore"
    }
  ]
}

Definitions

Name Description
DatasetUserAccess

A Power BI principal access right entry for a dataset

DatasetUserAccessRight

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

DatasetUsersAccess

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

PrincipalType

The principal type

DatasetUserAccess

A Power BI principal access right entry for a dataset

Name Type Description
datasetUserAccessRight

DatasetUserAccessRight

The access rights to assign to the user for the dataset (permission level)

identifier

string

For principal type User, provide the UPN. Otherwise provide the object ID of the principal.

principalType

PrincipalType

The principal type

DatasetUserAccessRight

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

Name Type Description
None

string

Removes permission to the content in the dataset

Read

string

Grants Read access to the content in the dataset

ReadExplore

string

Grants Read and Explore access to the content in the dataset

ReadReshare

string

Grants Read and Reshare access to the content in the dataset

ReadReshareExplore

string

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

ReadWrite

string

Grants Read and Write access to the content in the dataset

ReadWriteExplore

string

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

ReadWriteReshare

string

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

ReadWriteReshareExplore

string

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

DatasetUsersAccess

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

Name Type Description
odata.context

string

value

DatasetUserAccess[]

The list of users with access to a dataset

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