Pipelines - Get Pipeline Users

Returns a list of users that have access to the specified deployment pipeline.

Required Scope

Pipeline.ReadWrite.All or Pipeline.Read.All

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

URI Parameters

Name In Required Type Description
pipelineId
path True

string

uuid

The deployment pipeline ID

Responses

Name Type Description
200 OK

PipelineUsers

OK

Examples

Get users of a deployment pipeline example

Sample request

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

Sample response

{
  "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"
    }
  ]
}

Definitions

Name Description
PipelineUser

A Power BI user access right entry for a deployment pipeline

PipelineUserAccessRight

Required. The access right a user has for the deployment pipeline.

PipelineUsers

OData response wrapper for a collection of Power BI deployment pipeline users

PrincipalType

The principal type

PipelineUser

A Power BI user access right entry for a deployment pipeline

Name Type Description
accessRight

PipelineUserAccessRight

Required. The access right a user has for the deployment pipeline.

identifier

string

For principal type User, provide the UPN. Otherwise provide the object ID of the principal.

principalType

PrincipalType

The principal type

PipelineUserAccessRight

Required. The access right a user has for the deployment pipeline.

Name Type Description
Admin

string

Grants administrator rights to a deployment pipeline

PipelineUsers

OData response wrapper for a collection of Power BI deployment pipeline users

Name Type Description
odata.context

string

OData context

value

PipelineUser[]

The collection of deployment pipeline users

PrincipalType

The principal type

Name Type Description
App

string

Service principal type

Group

string

Group principal type

None

string

No principal type. Use for whole organization level access.

User

string

User principal type