Admin - Dataflows GetDataflowUsersAsAdmin

Returns a list of users that have access to the specified dataflow. This is a preview API call.

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.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

GET https://api.powerbi.com/v1.0/myorg/admin/dataflows/{dataflowId}/users

URI Parameters

Name In Required Type Description
dataflowId
path True
  • string
uuid

The dataflow ID

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dataflows/{dataflowId}/users

Sample Response

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

Definitions

DataflowUser

A Power BI user access right entry for dataflow

DataflowUserAccessRight

Access rights user has for the dataflow (Permission level)

DataflowUsers

Odata response wrapper for a Power BI user access right for dataflow List

PrincipalType

The principal type

DataflowUser

A Power BI user access right entry for dataflow

Name Type Description
DataflowUserAccessRight

Access rights user has for the dataflow (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

DataflowUserAccessRight

Access rights user has for the dataflow (Permission level)

Name Type Description
None
  • string

Removes permission to content in dataflow

Owner
  • string

Grants Read, Write and Reshare access to content in dataflow

Read
  • string

Grants Read access to content in dataflow

ReadReshare
  • string

Grants Read and Reshare access to content in dataflow

ReadWrite
  • string

Grants Read and Write access to content in dataflow

DataflowUsers

Odata response wrapper for a Power BI user access right for dataflow List

Name Type Description
odata.context
  • string
value

The user access right for dataflow List

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

User
  • string

User principal type