Gateways - Add Datasource User

Service:

Power BI REST APIs

API Version:

v1.0

授與或更新為指定使用者使用指定資料來源所需的許可權。

權限

使用者必須具有閘道管理員許可權。

必要範圍

Dataset.ReadWrite.All

限制

不支援虛擬網路 (VNet) 閘道。 不支援透過 API 新增群組。

POST https://api.powerbi.com/v1.0/myorg/gateways/{gatewayId}/datasources/{datasourceId}/users

URI 參數

名稱	位於	必要	類型	Description
datasourceId	path	True	string uuid	資料來源識別碼
gatewayId	path	True	string uuid	閘道識別碼。 使用閘道叢集時，閘道識別碼是指叢集中第一個) 閘道的主要 (。 在這種情況下，閘道識別碼類似于閘道叢集識別碼。

要求本文

名稱	必要	類型	Description
datasourceAccessRight	True	DatasourceUserAccessRight	使用者對資料來源擁有的許可權層級 (許可權等級)
displayName		string	主體的顯示名稱
emailAddress		string	使用者的電子郵件地址
identifier		string	主體的物件識別碼
principalType		PrincipalType	主體類型
profile		ServicePrincipalProfile	Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。

回應

名稱	類型	Description
200 OK		確定

範例

Assign the ReadOverrideEffectiveIdentity user access right to a service principal example

Example

Assign the ReadOverrideEffectiveIdentity user access right to a service principal example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970/users

Request Body

{
  "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "datasourceAccessRight": "ReadOverrideEffectiveIdentity"
}

Sample Response

Status code:

200

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970/users

Request Body

{
  "emailAddress": "john@contoso.com",
  "datasourceAccessRight": "Read"
}

Sample Response

Status code:

200

定義

名稱	Description
DatasourceUser	具有資料來源存取權的 Power BI 使用者
DatasourceUserAccessRight	使用者對資料來源擁有的許可權層級 (許可權等級)
PrincipalType	主體類型
ServicePrincipalProfile	Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。

DatasourceUser

具有資料來源存取權的 Power BI 使用者

名稱	類型	Description
datasourceAccessRight	DatasourceUserAccessRight	使用者對資料來源擁有的許可權層級 (許可權等級)
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
identifier	string	主體的物件識別碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體設定檔。 僅適用于Power BI Embedded多租使用者解決方案。

DatasourceUserAccessRight

使用者對資料來源擁有的許可權層級 (許可權等級)

名稱	類型	Description
None	string	沒有存取資料來源的許可權。 僅適用于更新使用者許可權時。
Read	string	使用者所擁有的資料集具有資料來源的讀取權限
ReadOverrideEffectiveIdentity	string	使用者可以覆寫Power BI Embedded的有效身分識別。 僅適用于內部部署 Analysis Services 資料來源。

PrincipalType

主體類型

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

ServicePrincipalProfile

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

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