Share via

Admin - Users GetUserArtifactAccessAsAdmin

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

Returns a list of Power BI items (such as reports or dashboards) that the specified user has access to.

Permissions

  • The user must be a Fabric 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/users/{userId}/artifactAccess
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/users/{userId}/artifactAccess?continuationToken={continuationToken}&artifactTypes={artifactTypes}

URI Parameters

Name In Required Type Description
userId
 path True

string

The graph ID or user principal name (UPN) of the user
artifactTypes
 query

string

Comma separated list of artifact types.
continuationToken
 query

string

Token required to get the next chunk of the result set

Responses

Name Type Description
200 OK

ArtifactAccessResponse

OK

Examples

Example
Example with artifactTypes
Example with Guest User
Example with UPN

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/artifactAccess

Sample response

Status code:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/f089354e-8366-4e18-aea3-4cb4a3a50b48/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with artifactTypes

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser@microsoft.com/artifactAccess?artifactTypes=Dataflow,Dashboard

Sample response

Status code:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "09ce06d1-e81b-fea0-1c6d-8fe3dd2f8e87",
      "displayName": "Test Dataflow",
      "artifactType": "Dataflow",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser%40microsoft.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with Guest User

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser_microsoft.com%23EXT%23@contoso.com/artifactAccess

Sample response

Status code:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser_microsoft.com%23EXT%23%40contoso.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Example with UPN

Sample request

GET https://api.powerbi.com/v1.0/myorg/admin/users/testUser@microsoft.com/artifactAccess

Sample response

Status code:
200 
{
  "artifactAccessEntities": [
    {
      "artifactId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "displayName": "test report",
      "artifactType": "Report",
      "accessRight": "ReadWrite"
    }
  ],
  "continuationUri": "https://api.powerbi.com/v1.0/myorg/admin/users/testUser%40microsoft.com/artifactAccess?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Definitions

Name Description
ArtifactAccessEntry

A user access entry for a Power BI item
ArtifactAccessResponse

The OData response wrapper for a list of Power BI items (such as reports or dashboards) that a user can access
ArtifactType

The artifact type
PrincipalType

The principal type
ServicePrincipalProfile

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

A Power BI user

ArtifactAccessEntry

Object

A user access entry for a Power BI item

Name Type Description
accessRight

string

The access right that the user has for the Power BI item
artifactId

string

The Power BI item ID
artifactType

ArtifactType

The type of Power BI item
displayName

string

The display name of the Power BI item
shareType

string

The type of how the access is given to the Power BI item. Only available for widely shared artifacts APIs.
sharer

User

The user who shared the Power BI item. Only available for widely shared artifacts APIs.

ArtifactAccessResponse

Object

The OData response wrapper for a list of Power BI items (such as reports or dashboards) that a user can access

Name Type Description
@odata.context

string

artifactAccessEntities

ArtifactAccessEntry[]

The list of Power BI items that a user can access
continuationToken

string

The token for the next chunk in the result set
continuationUri

string

The URI of the next chunk in the result set

ArtifactType

Enumeration

The artifact type

Value Description
Report

Power BI Report
PaginatedReport

Power BI Paginated Report
Dashboard

Power BI Dashboard
Dataset

Power BI Dataset
Dataflow

Power BI Dataflow
PersonalGroup

My workspace object
Group

V1 shared workspace object
Workspace

Shared workspace object
Capacity

Capacity object
App

Power BI Apps

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

User

Object

A Power BI user

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.
userType

string

Type of the user.