Κοινή χρήση μέσω


Admin - Reports GetReportUsersAsAdmin

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

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/reports/{reportId}/users

URI Parameters

Name In Required Type Description
reportId
path True

string

uuid

The report ID

Responses

Name Type Description
200 OK

ReportUsers

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/users

Sample response

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

Definitions

Name Description
PrincipalType

The principal type

ReportUser

A Power BI user access right entry for a report

ReportUserAccessRight

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

ReportUsers

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

ServicePrincipalProfile

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

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

ReportUser

A Power BI user access right entry for a report

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

reportUserAccessRight

ReportUserAccessRight

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

userType

string

Type of the user.

ReportUserAccessRight

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

Name Type Description
None

string

No permission to content in report

Owner

string

Grants Read, Write and Reshare access to content in report

Read

string

Grants Read access to content in report

ReadCopy

string

Grants Read and Copy access to content in report

ReadReshare

string

Grants Read and Reshare access to content in report

ReadWrite

string

Grants Read and Write access to content in report

ReportUsers

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

Name Type Description
odata.context

string

value

ReportUser[]

The list of users with access to a report

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