共用方式為

Groups - Get Group Users

服務:
Power BI REST APIs
API 版本:
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
含選擇性參數: 
GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users?$top={$top}&$skip={$skip}

URI 參數

名稱 位於 必要 類型 Description
groupId
 path True

string (uuid)

工作區標識碼
$skip
 query

integer (int32)

略過前 n 個結果
$top
 query

integer (int32)

只傳回前 n 個結果

回應

名稱 類型 Description
200 OK

GroupUsers

還行

範例

Example

範例要求

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

範例回覆

狀態碼:
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"
    }
  ]
}

定義

名稱 Description
GroupUser

可存取工作區的Power BI 使用者
GroupUserAccessRight

使用者在工作區上擁有的存取權限（權限等級）
GroupUsers

具有工作區存取權的Power BI使用者清單的 OData 回應包裝函式
PrincipalType

主體類型
ServicePrincipalProfile

Power BI 服務主體配置檔。 僅與 Power BI Embedded 多租使用者解決方案相關。

GroupUser

Object

可存取工作區的Power BI 使用者

名稱 類型 Description
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

列舉型別

使用者在工作區上擁有的存取權限（權限等級）

值 Description
None

沒有工作區內容的存取權
Member

讀取、重新共用和探索工作區內容的訪問許可權
Admin

工作區內容的系統管理員許可權
Contributor

讀取和探索工作區內容的存取權
Viewer

工作區內容的唯讀存取權

GroupUsers

Object

具有工作區存取權的Power BI使用者清單的 OData 回應包裝函式

名稱 類型 Description
@odata.context

string

value

GroupUser[]

具有工作區存取權的用戶清單

PrincipalType

列舉型別

主體類型

值 Description
None

沒有主體類型。 用於整個組織層級存取。
User

用戶主體類型
Group

群組主體類型
App

服務主體類型

ServicePrincipalProfile

Object

Power BI 服務主體配置檔。 僅與 Power BI Embedded 多租使用者解決方案相關。

名稱 類型 Description
displayName

string

服務主體配置檔名稱
id

string (uuid)

服務主體配置檔識別碼