Admin - Groups GetGroupUsersAsAdmin

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースにアクセスできるユーザーの一覧を返します。

アクセス許可

ユーザーは管理者権限 (Office 365グローバル管理者や Power BI サービス管理者など) を持っているか、サービスプリンシパルを使用して認証する必要があります。
委任されたアクセス許可がサポートされています。

サービスの prinicipal 認証で実行する場合、アプリには、Azure portalで Power BI に対して管理者の同意が必要な事前使用許可が設定されていない必要があります。

必要なスコープ

Tenant.Read.All または Tenant.ReadWrite.All

標準の委任された管理者アクセストークンを使用して認証する場合にのみ関連します。サービスプリンシパル経由の認証を使用する場合は、存在しないようにする必要があります。

制限事項

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

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

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string uuid	ワークスペース ID

応答

名前	型	説明
200 OK	GroupUsers	OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Sample Response

Status code:: 200

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin",
      "identifier": "john@contoso.com",
      "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
      "principalType": "User"
    },
    {
      "displayName": "Adam Wood",
      "emailAddress": "Adam@contoso.com",
      "groupUserAccessRight": "Member",
      "identifier": "Adam@contoso.com",
      "graphId": "785e192c-0f1f-41ca-ae7a-a85da28e565a",
      "principalType": "User"
    },
    {
      "displayName": "ContosoTestApp",
      "groupUserAccessRight": "Admin",
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "graphId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App"
    }
  ]
}

定義

名前	説明
GroupUser	ワークスペースにアクセスできる Power BI ユーザー
GroupUserAccessRight	ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
GroupUsers	ワークスペースにアクセスできる Power BI ユーザーの一覧の OData 応答ラッパー
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	ワークスペースコンテンツへの読み取り専用 (読み取り) アクセス

GroupUsers

ワークスペースにアクセスできる Power BI ユーザーの一覧の OData 応答ラッパー

名前	型	説明
odata.context	string
value	GroupUser[]	ワークスペースにアクセスできるユーザーの一覧

PrincipalType

プリンシパルの種類

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

ServicePrincipalProfile

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

名前	型	説明
displayName	string	サービスプリンシパルプロファイル名
id	string	サービスプリンシパルプロファイル ID