Admin - Datasets GetDatasetUsersAsAdmin

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

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.
  • The permissions for this API call are listed in Datasets permissions.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

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

OK

Examples

Example

Sample Request

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

Sample Response

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

Definitions

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

A Power BI user access right entry for a dataset

Name Type Description
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

The principal type

profile

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

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

DatasetUsers

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

Name Type Description
odata.context
  • string
value

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

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