Admin - Users GetUserArtifactAccessAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

返回指定用户有权访问的 Power BI 项 (列表，例如报表或仪表板) 。

权限

• 用户必须具有管理员权限 (，例如Office 365全局管理员或 Power BI 服务管理员) 或使用服务主体进行身份验证。
• 支持委派权限。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

限制

每小时最多 200 个请求。

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 参数

名称	在	必需	类型	说明
userId	path	True	string	用户 UPN) (图形 ID 或用户主体名称
artifactTypes	query		string	项目类型的逗号分隔列表。
continuationToken	query		string	获取结果集的下一个区块所需的令牌

响应

名称	类型	说明
200 OK	ArtifactAccessResponse	确定

示例

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"
}

定义

名称	说明
ArtifactAccessEntry	Power BI 项的用户访问条目
ArtifactAccessResponse	Power BI 项列表的 OData 响应包装器 (，例如用户可以访问的报表或仪表板)
ArtifactType	项目类型
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。
User	Power BI 用户

ArtifactAccessEntry

Power BI 项的用户访问条目

名称	类型	说明
accessRight	string	用户对 Power BI 项拥有的访问权限
artifactId	string	Power BI 项 ID
artifactType	ArtifactType	Power BI 项的类型
displayName	string	Power BI 项的显示名称
shareType	string	授予对 Power BI 项的访问权限的类型。 仅适用于广泛共享的项目 API。
sharer	User	共享 Power BI 项的用户。 仅适用于广泛共享的项目 API。

ArtifactAccessResponse

Power BI 项列表的 OData 响应包装器 (，例如用户可以访问的报表或仪表板)

名称	类型	说明
artifactAccessEntities	ArtifactAccessEntry[]	用户可以访问的 Power BI 项列表
continuationToken	string	结果集中下一个区块的标记
continuationUri	string	结果集中下一个区块的 URI
odata.context	string

ArtifactType

项目类型

名称	类型	说明
App	string	Power BI 应用
Capacity	string	Capacity 对象
Dashboard	string	Power BI 仪表板
Dataflow	string	Power BI 数据流
Dataset	string	Power BI 数据集
Group	string	V1 共享工作区对象
PaginatedReport	string	Power BI 分页报表
PersonalGroup	string	我的工作区对象
Report	string	Power BI 报表
Workspace	string	共享工作区对象

PrincipalType

主体类型

名称	类型	说明
App	string	服务主体类型
Group	string	组主体类型
None	string	无主体类型。 用于整个组织级别的访问。
User	string	用户主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。

名称	类型	说明
displayName	string	服务主体配置文件名称
id	string	服务主体配置文件 ID

User

Power BI 用户

名称	类型	说明
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。 仅适用于管理员 API。
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。