Groups - Add Group User

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

指定したユーザーに、指定したワークスペースに対するアクセス許可を付与します。

アクセス許可

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedのサービス プリンシパル プロファイル」を参照してください。

必要なスコープ

Workspace.ReadWrite.All

制限事項

  • ワークスペースのユーザーアクセス許可は更新に時間がかかり、API 呼び出しを使用するとすぐには使用できない場合があります。 ユーザーのアクセス許可を更新するには、 Refresh User Permissions API 呼び出しを使用します。 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users

URI パラメーター

名前 / 必須 型 説明
groupId
 path True

string

uuid

ワークスペース ID

要求本文

名前 必須 型 説明
groupUserAccessRight True

GroupUserAccessRight

ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
identifier True

string

プリンシパルの識別子
principalType True

PrincipalType

プリンシパルの種類
displayName

string

プリンシパルの表示名
emailAddress

string

ユーザーの電子メール アドレス
graphId

string

Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。
profile

ServicePrincipalProfile

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

string

ユーザーの種類。

応答

名前 型 説明
200 OK

OK

例

Assign administrator user access rights to a service principal example
Example

Assign administrator user access rights to a service principal example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Request Body
{
  "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "groupUserAccessRight": "Admin",
  "principalType": "App"
}

Sample Response

Status code:
200

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Request Body
{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Sample Response

Status code:
200

定義

名前 説明
GroupUser

ワークスペースにアクセスできる Power BI ユーザー
GroupUserAccessRight

ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
PrincipalType

プリンシパルの種類
ServicePrincipalProfile

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

GroupUser

ワークスペースにアクセスできる Power BI ユーザー

名前 型 説明
displayName

string

プリンシパルの表示名
emailAddress

string

ユーザーの電子メール アドレス
graphId

string

Microsoft Graph のプリンシパルの識別子。 管理者 API でのみ使用できます。
groupUserAccessRight

GroupUserAccessRight

ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
identifier

string

プリンシパルの識別子
principalType

PrincipalType

プリンシパルの種類
profile

ServicePrincipalProfile

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

string

ユーザーの種類。

GroupUserAccessRight

ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)

名前 型 説明
Admin

string

ワークスペース コンテンツに対する管理者権限
Contributor

string

ワークスペース コンテンツへの読み取りと探索 (ReadExplore) アクセス
Member

string

ワークスペース コンテンツに対する読み取り、再共有、探索 (ReadReshareExplore) アクセス権
None

string

ワークスペース コンテンツにアクセスできない
Viewer

string

ワークスペース コンテンツへの読み取り専用 (読み取り) アクセス

PrincipalType

プリンシパルの種類

名前 型 説明
App

string

サービス プリンシパルの種類
Group

string

グループ プリンシパルの種類
None

string

プリンシパルの種類はありません。 organization レベルのアクセス全体に使用します。
User

string

ユーザー プリンシパルの種類

ServicePrincipalProfile

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

名前 型 説明
displayName

string

サービス プリンシパル プロファイル名
id

string

サービス プリンシパル プロファイル ID