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		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の有効な ID をオーバーライドできます。 オンプレミスの Analysis Services データ ソースにのみ適用されます。

PrincipalType

プリンシパルの種類

名前	型	説明
App	string	サービス プリンシパルの種類
Group	string	グループ プリンシパルの種類
None	string	プリンシパルの種類はありません。 organization レベル全体のアクセスに使用します。
User	string	ユーザー プリンシパルの種類

ServicePrincipalProfile

Power BI サービス プリンシパル プロファイル。 マルチテナント ソリューションPower BI Embeddedにのみ関連します。

名前	型	説明
displayName	string	サービス プリンシパル プロファイル名
id	string	サービス プリンシパル プロファイル ID