Groups - Get Group Users

サービス:: Power BI REST APIs

API バージョン:: v1.0

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

Permissions

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

必要なスコープ

Workspace.Read.All または Workspace.ReadWrite.All

制限事項

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

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

省略可能なパラメーターを含む:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users?$top={$top}&$skip={$skip}

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string (uuid)	ワークスペース ID
$skip	query		integer (int32)	最初の n 件の結果をスキップします
$top	query		integer (int32)	最初の n 個の結果のみを返します

応答

名前	型	説明
200 OK	GroupUsers	[OK]

例

Example

要求のサンプル

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "displayName": "John Nick",
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin",
      "identifier": "john@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "Adam Wood",
      "emailAddress": "Adam@contoso.com",
      "groupUserAccessRight": "Member",
      "identifier": "Adam@contoso.com",
      "principalType": "User"
    },
    {
      "displayName": "ContosoTestApp",
      "groupUserAccessRight": "Admin",
      "identifier": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "principalType": "App"
    }
  ]
}

定義

名前	説明
GroupUser	ワークスペースにアクセスできる Power BI ユーザー
GroupUserAccessRight	ユーザーがワークスペースに対して持っているアクセス権 (アクセス許可レベル)
GroupUsers	ワークスペースにアクセスできる Power BI ユーザーの一覧の OData 応答ラッパー
PrincipalType	プリンシパルの種類
ServicePrincipalProfile	Power BI サービスプリンシパルプロファイル。 Power BI Embedded マルチテナントソリューションにのみ関連します。

GroupUser

Object

ワークスペースにアクセスできる 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

列挙

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

値	説明
None	ワークスペースコンテンツにアクセスできない
Member	ワークスペースコンテンツに対する読み取り、再共有、探索 (ReadReshareExplore) アクセス権
Admin	ワークスペースコンテンツに対する管理者権限
Contributor	ワークスペースコンテンツへの読み取りと探索 (ReadExplore) アクセス
Viewer	ワークスペースコンテンツへの読み取り専用 (読み取り) アクセス

GroupUsers

Object

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

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

PrincipalType

列挙

プリンシパルの種類

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

ServicePrincipalProfile

Object

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

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

次の方法で共有

Groups - Get Group Users

Permissions

必要なスコープ

制限事項

URI パラメーター

応答

例

Example

要求のサンプル

応答のサンプル

定義

GroupUser

GroupUserAccessRight

GroupUsers

PrincipalType

ServicePrincipalProfile