Admin - Pipelines UpdateUserAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Octroie des autorisations utilisateur à un pipeline de déploiement spécifié.

Autorisations

L’utilisateur doit disposer de droits d’administrateur.

Étendue requise

Tenant.ReadWrite.All

Limites

200 requêtes maximales par heure.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
pipelineId	path	True	string uuid	ID du pipeline de déploiement

Corps de la demande

Nom	Obligatoire	Type	Description
identifier	True	string	Pour le type Userde principal, indiquez l’UPN. Sinon, fournissez l’ID d’objet du principal.
principalType	True	PrincipalType	Type de principal
accessRight		PipelineUserAccessRight	Obligatoire. Droit d’accès dont dispose un utilisateur pour le pipeline de déploiement.

Réponses

Nom	Type	Description
200 OK		Ok

Exemples

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/admin/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/admin/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/admin/pipelines/8ce96c50-85a0-4db3-85c6-7ccc3ed46523/users

Request Body

{
  "identifier": "john@contoso.com",
  "accessRight": "Admin",
  "principalType": "User"
}

Sample Response

Status code:

200

Définitions

Nom	Description
PipelineUser	Entrée de droit d’accès utilisateur Power BI pour un pipeline de déploiement
PipelineUserAccessRight	Obligatoire. Droit d’accès dont dispose un utilisateur pour le pipeline de déploiement.
PrincipalType	Type de principal

PipelineUser

Entrée de droit d’accès utilisateur Power BI pour un pipeline de déploiement

Nom	Type	Description
accessRight	PipelineUserAccessRight	Obligatoire. Droit d’accès dont dispose un utilisateur pour le pipeline de déploiement.
identifier	string	Pour le type Userde principal, indiquez l’UPN. Sinon, fournissez l’ID d’objet du principal.
principalType	PrincipalType	Type de principal

PipelineUserAccessRight

Obligatoire. Droit d’accès dont dispose un utilisateur pour le pipeline de déploiement.

Nom	Type	Description
Admin	string	Octroie des droits d’administrateur à un pipeline de déploiement

PrincipalType

Type de principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User	string	Type d’utilisateur principal