Admin - Pipelines UpdateUserAsAdmin

Grants user permissions to a specified deployment pipeline.

Permissions

The user must have administrator rights.

Required scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour.

POST https://api.powerbi.com/v1.0/myorg/admin/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 UPN , otherwise provide Object ID of the principal

principalType True

The principal type

accessRight

Required - Access rights a user has for the deployment pipeline.

Responses

Name Type Description
200 OK

OK

Examples

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

Add group to a deployment pipeline

Sample Request

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

Sample Response

Add service principal to a deployment pipeline

Sample Request

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

Sample Response

Add user to a deployment pipeline

Sample Request

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

Sample Response

Definitions

PipelineUser

A Power BI user access right entry for a deployment pipeline.

PipelineUserAccessRight

Required - Access rights a user has for the deployment pipeline.

PrincipalType

The principal type

PipelineUser

A Power BI user access right entry for a deployment pipeline.

Name Type Description
accessRight

Required - Access rights a user has for the deployment pipeline.

identifier
  • string

For Principal type 'User' provide UPN , otherwise provide Object ID of the principal

principalType

The principal type

PipelineUserAccessRight

Required - Access rights a user has for the deployment pipeline.

Name Type Description
Admin
  • string

Grants administrator rights to a deployment pipeine

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

User
  • string

User principal type