Pipelines - Get Pipeline Users

サービス:

Power BI REST APIs

API バージョン:

v1.0

指定したデプロイ パイプラインにアクセスできるユーザーの一覧を返します。

必要なスコープ

Pipeline.ReadWrite.All または Pipeline.Read.All

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/users

URI パラメーター

名前	/	必須	型	説明
pipelineId	path	True	string uuid	デプロイ パイプライン ID

応答

名前	型	説明
200 OK	PipelineUsers	OK

例

Get users of a deployment pipeline example

要求のサンプル

GET https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "identifier": "john@contoso.com",
      "accessRight": "Admin",
      "principalType": "User"
    },
    {
      "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
      "accessRight": "Admin",
      "principalType": "Group"
    },
    {
      "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
      "accessRight": "Admin",
      "principalType": "App"
    }
  ]
}

定義

名前	説明
PipelineUser	デプロイ パイプラインの Power BI ユーザー アクセス権エントリ
PipelineUserAccessRight	必須です。 ユーザーがデプロイ パイプラインに対して持っているアクセス権。
PipelineUsers	Power BI デプロイ パイプライン ユーザーのコレクションの OData 応答ラッパー
PrincipalType	プリンシパルの種類

PipelineUser

Object

デプロイ パイプラインの Power BI ユーザー アクセス権エントリ

名前	型	説明
accessRight	PipelineUserAccessRight	必須です。 ユーザーがデプロイ パイプラインに対して持っているアクセス権。
identifier	string	プリンシパルの種類 Userの場合は、 UPN を指定します。 それ以外の場合は、プリンシパルの オブジェクト ID を 指定します。
principalType	PrincipalType	プリンシパルの種類

PipelineUserAccessRight

Enumeration

必須です。 ユーザーがデプロイ パイプラインに対して持っているアクセス権。

値	説明
Admin	デプロイ パイプラインに対する管理者権限を付与します

PipelineUsers

Object

Power BI デプロイ パイプライン ユーザーのコレクションの OData 応答ラッパー

名前	型	説明
@odata.context	string	OData コンテキスト
value	PipelineUser[]	デプロイ パイプライン ユーザーのコレクション

PrincipalType

Enumeration

プリンシパルの種類

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