Datasets - Put Dataset User In Group

Service:

Power BI REST APIs

API Version:

v1.0

指定したユーザーの既存のデータセットのアクセス許可を、指定したアクセス許可に更新します。

データセットに対するユーザーのアクセス許可が最近更新された場合、API 呼び出しを通じて新しいアクセス許可をすぐに使用できない場合があります。 ユーザーのアクセス許可を更新するには、 Refresh User Permissions API 呼び出しを使用します。 この API 呼び出しを使用すると、指定したユーザーのすべてのデータセットのアクセス許可を削除できます。 datasetUserAccessRight: None

必要なスコープ

Dataset.ReadWrite.All

アクセス許可

この API 呼び出しのアクセス許可は、 データセットのアクセス許可に記載されています。

制限事項

• サービス プリンシパル (アプリ プリンシパルタイプ) へのアクセス許可の更新はサポートされていません
• 呼び出し元には、データセットに対する ReadWriteReshare アクセス許可が必要です。 つまり、フォルダー管理者、再共有アクセス許可を持つメンバーと共同作成者、またはデータセットの所有者です。
• この API を使用して書 き込み アクセス許可を追加または削除することはできません。
• この API を使用して、フォルダー レベルの継承されたアクセス許可を削除することはできません。 フォルダー管理者とメンバーの場合、フォルダーのデータセットに対する ReadWriteReshareExplore アクセス許可が継承されます。 フォルダーの共同作成者の場合、フォルダーのデータセットに対する ReadWriteExplore アクセス許可が継承されます。 フォルダー ビューアーの場合、フォルダーのデータセットに対する読み取りアクセス許可が継承されます。
  
  

PUT https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/users

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID
groupId	path	True	string uuid	ワークスペース ID

要求本文

名前	必須	型	説明
datasetUserAccessRight	True	DatasetUserAccessRight	データセットのユーザーに割り当てるアクセス権 (アクセス許可レベル)
identifier	True	string	プリンシパルの種類 Userの場合は、 UPN を指定します。 それ以外の場合は、プリンシパルの オブジェクト ID を 指定します。
principalType	True	PrincipalType	プリンシパルの種類

応答

名前	型	説明
200 OK		OK

例

Example

Example for updating security group dataset permissions to ReadExplore

Example

Sample Request

PUT https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/users

Request Body

{
  "identifier": "john@contoso.com",
  "principalType": "User",
  "datasetUserAccessRight": "Read"
}

Sample Response

Status code:

200

Example for updating security group dataset permissions to ReadExplore

Sample Request

PUT https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/users

Request Body

{
  "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "principalType": "Group",
  "datasetUserAccessRight": "ReadReshare"
}

Sample Response

Status code:

200

定義

名前	説明
DatasetUserAccess	データセットの Power BI プリンシパル アクセス権エントリ
DatasetUserAccessRight	ユーザーがデータセットに対して持つアクセス権 (アクセス許可レベル)
PrincipalType	プリンシパルの種類

DatasetUserAccess

データセットの Power BI プリンシパル アクセス権エントリ

名前	型	説明
datasetUserAccessRight	DatasetUserAccessRight	データセットのユーザーに割り当てるアクセス権 (アクセス許可レベル)
identifier	string	プリンシパルの種類 Userの場合は、 UPN を指定します。 それ以外の場合は、プリンシパルの オブジェクト ID を 指定します。
principalType	PrincipalType	プリンシパルの種類

DatasetUserAccessRight

ユーザーがデータセットに対して持つアクセス権 (アクセス許可レベル)

名前	型	説明
None	string	データセット内のコンテンツに対するアクセス許可を削除します
Read	string	データセット内のコンテンツへの読み取りアクセス権を付与します
ReadExplore	string	データセット内のコンテンツへの読み取りと探索のアクセス権を付与します
ReadReshare	string	データセット内のコンテンツへの読み取りと再共有のアクセスを許可します
ReadReshareExplore	string	データセット内のコンテンツへの読み取り、再共有、探索のアクセス権を付与します
ReadWrite	string	データセット内のコンテンツへの読み取りと書き込みのアクセス権を付与します
ReadWriteExplore	string	データセット内のコンテンツへの読み取り、書き込み、探索のアクセス権を付与します
ReadWriteReshare	string	データセット内のコンテンツへの読み取り、書き込み、再共有のアクセス権を付与します
ReadWriteReshareExplore	string	データセット内のコンテンツへの読み取り、書き込み、再共有、探索アクセスを許可します

PrincipalType

プリンシパルの種類

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