Groups - Update Group User
指定したユーザーのアクセス許可を、指定したワークスペースに更新します。
権限
この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedでのサービス プリンシパル プロファイルの
必要なスコープ
Workspace.ReadWrite.All
制限事項
- ワークスペースのユーザーアクセス許可は更新に時間がかかるため、API 呼び出しを使用するときにすぐに使用できない場合があります。 ユーザーのアクセス許可を更新するには、api 呼び出し ユーザーのアクセス許可の更新 を使用します。
PUT https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
group
|
path | True |
string (uuid) |
ワークスペース ID |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| groupUserAccessRight | True |
ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル) |
|
| identifier | True |
string |
プリンシパルの識別子 |
| principalType | True |
プリンシパルの種類 |
|
| displayName |
string |
プリンシパルの表示名 |
|
| emailAddress |
string |
ユーザーのメール アドレス |
|
| graphId |
string |
Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。 |
|
| profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
||
| userType |
string |
ユーザーの種類。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
わかりました |
例
| Assign administrator user access rights to a service principal example |
| Example |
Assign administrator user access rights to a service principal example
要求のサンプル
PUT https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
{
"identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
"groupUserAccessRight": "Admin",
"principalType": "App"
}
応答のサンプル
Example
要求のサンプル
PUT https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
{
"emailAddress": "john@contoso.com",
"groupUserAccessRight": "Admin"
}
応答のサンプル
定義
| 名前 | 説明 |
|---|---|
|
Group |
ワークスペースにアクセスできる Power BI ユーザー |
|
Group |
ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル) |
|
Principal |
プリンシパルの種類 |
|
Service |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
GroupUser
ワークスペースにアクセスできる Power BI ユーザー
| 名前 | 型 | 説明 |
|---|---|---|
| displayName |
string |
プリンシパルの表示名 |
| emailAddress |
string |
ユーザーのメール アドレス |
| graphId |
string |
Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。 |
| groupUserAccessRight |
ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル) |
|
| identifier |
string |
プリンシパルの識別子 |
| principalType |
プリンシパルの種類 |
|
| profile |
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。 |
|
| userType |
string |
ユーザーの種類。 |
GroupUserAccessRight
ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
| 値 | 説明 |
|---|---|
| None |
ワークスペース コンテンツにアクセスできない |
| Member |
ワークスペース コンテンツに対する読み取り、再共有、探索 (ReadReshareExplore) アクセス権 |
| Admin |
ワークスペース コンテンツに対する管理者権限 |
| Contributor |
ワークスペース コンテンツへの読み取りと探索 (ReadExplore) アクセス |
| Viewer |
ワークスペース コンテンツへの読み取り専用 (読み取り) アクセス |
PrincipalType
プリンシパルの種類
| 値 | 説明 |
|---|---|
| None |
プリンシパルの種類はありません。 組織全体レベルのアクセスに使用します。 |
| User |
ユーザー プリンシパルの種類 |
| Group |
グループ プリンシパルの種類 |
| App |
サービス プリンシパルの種類 |
ServicePrincipalProfile
Power BI サービス プリンシパル プロファイル。 Power BI Embedded マルチテナント ソリューションにのみ関連します。
| 名前 | 型 | 説明 |
|---|---|---|
| displayName |
string |
サービス プリンシパル プロファイル名 |
| id |
string (uuid) |
サービス プリンシパル プロファイル ID |