Admin - Groups AddUserAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

授與使用者許可權給指定的工作區。

此 API 呼叫僅支援新增使用者、安全性群組、M365 群組和服務主體。

權限

使用者必須具有系統管理員許可權 (，例如Office 365全域管理員或 Power BI 服務管理員) 。

必要範圍

Tenant.ReadWrite.All

限制

每小時最多 200 個要求。

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

URI 參數

名稱	位於	必要	類型	Description
groupId	path	True	string uuid	工作區識別碼

要求本文

名稱	必要	類型	Description
groupUserAccessRight	True	GroupUserAccessRight	使用者在工作區上擁有的許可權等級 (許可權等級)
identifier	True	string	主體的識別碼
principalType	True	PrincipalType	主體類型
displayName		string	主體的顯示名稱
emailAddress		string	使用者的電子郵件地址
graphId		string	Microsoft Graph 中主體的識別碼。 僅適用于系統管理員 API。
profile		ServicePrincipalProfile	Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。
userType		string	使用者的類型。

回應

名稱	類型	Description
200 OK		確定

範例

Add security group to workspace example

Add service principal to workspace example

Add user to group example

Add security group to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Sample Response

Status code:

200

Add service principal to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Sample Response

Status code:

200

Add user to group example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Sample Response

Status code:

200

定義

名稱	Description
GroupUser	具有工作區存取權的 Power BI 使用者
GroupUserAccessRight	使用者在工作區上擁有的許可權等級 (許可權等級)
PrincipalType	主體類型
ServicePrincipalProfile	Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。

GroupUser

具有工作區存取權的 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
Admin	string	工作區內容的系統管理員許可權
Contributor	string	讀取和探索 (ReadExplore) 工作區內容的存取權
Member	string	讀取、重新共用和探索 (ReadReshareExplore) 工作區內容的存取權限
None	string	無法存取工作區內容
Viewer	string	唯讀 (讀取工作區內容的) 存取權

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。 用於整個組織層級存取。
User	string	使用者主體類型

ServicePrincipalProfile

Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。

名稱	類型	Description
displayName	string	服務主體設定檔名稱
id	string	服務主體設定檔識別碼