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

名称	在	必需	类型	说明
datasourceId	path	True	string uuid	数据源 ID
gatewayId	path	True	string uuid	网关 ID。 使用网关群集时，网关 ID 是指群集中第一个) 网关的主 (。 在这种情况下，网关 ID 类似于网关群集 ID。

请求正文

名称	必需	类型	说明
datasourceAccessRight	True	DatasourceUserAccessRight	用户对数据源拥有的访问权限 (权限级别)
displayName		string	主体的显示名称
emailAddress		string	用户的电子邮件地址
identifier		string	主体的对象 ID
principalType		PrincipalType	主体类型
profile		ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。

响应

名称	类型	说明
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

定义

名称	说明
DatasourceUser	有权访问数据源的 Power BI 用户
DatasourceUserAccessRight	用户对数据源拥有的访问权限 (权限级别)
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。

DatasourceUser

有权访问数据源的 Power BI 用户

名称	类型	说明
datasourceAccessRight	DatasourceUserAccessRight	用户对数据源拥有的访问权限 (权限级别)
displayName	string	主体的显示名称
emailAddress	string	用户的电子邮件地址
identifier	string	主体的对象 ID
principalType	PrincipalType	主体类型
profile	ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案。

DatasourceUserAccessRight

用户对数据源拥有的访问权限 (权限级别)

名称	类型	说明
None	string	没有访问数据源的权限。 仅在更新用户权限时适用。
Read	string	用户拥有的数据集对数据源具有读取访问权限
ReadOverrideEffectiveIdentity	string	用户可以替代Power BI Embedded的有效标识。 仅适用于本地 Analysis Services 数据源。

PrincipalType

主体类型

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

ServicePrincipalProfile

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

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