Gateways - Add Datasource User
指定したユーザーに対して指定したデータ ソースを使用するために必要なアクセス許可を付与または更新します。
権限
ユーザーにはゲートウェイ管理者のアクセス許可が必要です。
必要なスコープ
Dataset.ReadWrite.All
制限事項
仮想ネットワーク (VNet) ゲートウェイはサポートされていません。
API を使用したグループの追加はサポートされていません。
POST https://api.powerbi.com/v1.0/myorg/gateways/{gatewayId}/datasources/{datasourceId}/users
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
datasource
|
path | True |
string (uuid) |
データ ソース ID |
|
gateway
|
path | True |
string (uuid) |
ゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照します。 このような場合、ゲートウェイ ID はゲートウェイ クラスター ID に似ています。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| datasourceAccessRight | True |
ユーザーがデータ ソースに対して持っているアクセス権 (アクセス許可レベル) |
|
| displayName |
string |
プリンシパルの表示名 |
|
| emailAddress |
string |
ユーザーのメール アドレス |
|
| identifier |
string |
プリンシパルの オブジェクト ID |
|
| principalType |
プリンシパルの種類 |
||
| profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
わかりました |
例
|
Assign the Read |
| 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"
}
応答のサンプル
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"
}
応答のサンプル
定義
| 名前 | 説明 |
|---|---|
|
Datasource |
データ ソースにアクセスできる Power BI ユーザー |
|
Datasource |
ユーザーがデータ ソースに対して持っているアクセス権 (アクセス許可レベル) |
|
Principal |
プリンシパルの種類 |
|
Service |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
DatasourceUser
データ ソースにアクセスできる Power BI ユーザー
| 名前 | 型 | 説明 |
|---|---|---|
| datasourceAccessRight |
ユーザーがデータ ソースに対して持っているアクセス権 (アクセス許可レベル) |
|
| displayName |
string |
プリンシパルの表示名 |
| emailAddress |
string |
ユーザーのメール アドレス |
| identifier |
string |
プリンシパルの オブジェクト ID |
| principalType |
プリンシパルの種類 |
|
| profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
DatasourceUserAccessRight
ユーザーがデータ ソースに対して持っているアクセス権 (アクセス許可レベル)
| 値 | 説明 |
|---|---|
| None |
データ ソースにアクセスするためのアクセス許可がありません。 ユーザーのアクセス許可を更新する場合にのみ適用されます。 |
| Read |
ユーザーが所有するデータセットは、データ ソースへの読み取りアクセス権を持っています |
| ReadOverrideEffectiveIdentity |
ユーザーは、Power BI Embedded の有効な ID をオーバーライドできます。 オンプレミスの Analysis Services データ ソースにのみ適用されます。 |
PrincipalType
プリンシパルの種類
| 値 | 説明 |
|---|---|
| None |
プリンシパルの種類はありません。 組織全体レベルのアクセスに使用します。 |
| User |
ユーザー プリンシパルの種類 |
| Group |
グループ プリンシパルの種類 |
| App |
サービス プリンシパルの種類 |
ServicePrincipalProfile
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。
| 名前 | 型 | 説明 |
|---|---|---|
| displayName |
string |
サービス プリンシパル プロファイル名 |
| id |
string (uuid) |
サービス プリンシパル プロファイル ID |