Gateways - Add Datasource User

服务:

Power BI REST APIs

API 版本:

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

示例请求

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

请求正文

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

示例响应

状态代码:

200

Example

示例请求

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

请求正文

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

示例响应

状态代码:

200

定义

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

DatasourceUser

Object

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

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

DatasourceUserAccessRight

枚举

用户对数据源拥有的访问权限（权限级别）

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

PrincipalType

枚举

主体类型

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

ServicePrincipalProfile

Object

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

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