Groups - Get Group Users

Service:

Power BI REST APIs

API Version:

v1.0

返回有权访问指定工作区的用户的列表。

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息，请参阅：Power BI Embedded 中的服务主体配置文件。

所需范围

Workspace.Read.All 或 Workspace.ReadWrite.All

限制

• 工作区的用户权限需要一段时间才能更新，使用 API 调用时可能无法立即可用。 若要刷新用户权限，请使用 刷新用户权限 API 调用。
  
  

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users?$top={$top}&$skip={$skip}

URI 参数

名称	在	必需	类型	说明
groupId	path	True	string uuid	工作区 ID
$skip	query		integer int32	跳过前 n 个结果
$top	query		integer int32	仅返回前 n 个结果

响应

名称	类型	说明
200 OK	GroupUsers	OK

示例

Example

Sample Request

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

Sample Response

Status code:

200

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin",
      "identifier": "john@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "Adam Wood",
      "emailAddress": "Adam@contoso.com",
      "groupUserAccessRight": "Member",
      "identifier": "Adam@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "ContosoTestApp",
      "groupUserAccessRight": "Admin",
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App"
    }
  ]
}

定义

名称	说明
GroupUser	有权访问工作区的 Power BI 用户
GroupUserAccessRight	用户对工作区拥有的访问权限 (权限级别)
GroupUsers	有权访问工作区的 Power BI 用户列表的 OData 响应包装器
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。

GroupUser

有权访问工作区的 Power BI 用户

名称	类型	说明
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
graphId	string	Microsoft Graph 中主体的标识符。 仅适用于管理员 API。
groupUserAccessRight	GroupUserAccessRight	用户对工作区拥有的访问权限 (权限级别)
identifier	string	主体的标识符
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。
userType	string	用户的类型。

GroupUserAccessRight

用户对工作区拥有的访问权限 (权限级别)

名称	类型	说明
Admin	string	工作区内容的管理员权限
Contributor	string	读取和浏览 (ReadExplore) 工作区内容的访问权限
Member	string	读取、重新共享和浏览 (ReadReshareExplore) 工作区内容的访问权限
None	string	无法访问工作区内容
Viewer	string	只读 (对工作区内容的读取) 访问权限

GroupUsers

有权访问工作区的 Power BI 用户列表的 OData 响应包装器

名称	类型	说明
odata.context	string
value	GroupUser[]	有权访问工作区的用户列表

PrincipalType

主体类型

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

ServicePrincipalProfile

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

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