Admin - Groups AddUserAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

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

この API 呼び出しでは、ユーザー、セキュリティ グループ、M365 グループ、サービス プリンシパルの追加のみがサポートされます。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っている必要があります。

必要なスコープ

Tenant.ReadWrite.All

制限事項

1 時間あたり最大 200 要求。

POST https://api.powerbi.com/v1.0/myorg/admin/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

例

Add security group to workspace example

Add service principal to workspace example

Add user to group example

Add security group to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Sample Response

Status code:

200

Add service principal to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Sample Response

Status code:

200

Add user to group example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/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