Share via

Pipelines - Update Pipeline User

Service:
Power BI REST APIs
API Version:
v1.0

Grants user permissions to the specified deployment pipeline.

Required Scope

Pipeline.ReadWrite.All 

POST 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

Request Body

Name Required Type Description
identifier True

string

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

PrincipalType

The principal type
accessRight

PipelineUserAccessRight

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

Responses

Name Type Description
200 OK

OK

Examples

Add a group to a deployment pipeline example
Add a service principal to a deployment pipeline example
Add a user to a deployment pipeline example

Add a group to a deployment pipeline example

Sample request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "154aef10-47b8-48c4-ab97-f0bf9d5f8fcf",
  "accessRight": "Admin",
  "principalType": "Group"
}

Sample response

Status code:
200

Add a service principal to a deployment pipeline example

Sample request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "a35d842b-90d5-59a1-c56a-5f8fcff0bf9d",
  "accessRight": "Admin",
  "principalType": "App"
}

Sample response

Status code:
200

Add a user to a deployment pipeline example

Sample request

POST https://api.powerbi.com/v1.0/myorg/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users
Request Body
{
  "identifier": "john@contoso.com",
  "accessRight": "Admin",
  "principalType": "User"
}

Sample response

Status code:
200

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.
PrincipalType

The principal type

PipelineUser

Object

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

Enumeration

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

Value Description
Admin

Grants administrator rights to a deployment pipeline

PrincipalType

Enumeration

The principal type

Value Description
None

No principal type. Use for whole organization level access.
User

User principal type
Group

Group principal type
App

Service principal type