Admin - Groups AddUserAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Octroie des autorisations utilisateur à l’espace de travail spécifié.

Cet appel d’API prend uniquement en charge l’ajout d’un utilisateur, d’un groupe de sécurité, d’un groupe M365 et d’un principal de service.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (tels que Office 365 Administrateur général ou Administrateur de service Power BI).

Étendue requise

Tenant.ReadWrite.All

Limites

Maximum 200 requêtes par heure.

POST https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/users

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
groupId	path	True	string uuid	L’ID de l’espace de travail

Corps de la demande

Nom	Obligatoire	Type	Description
groupUserAccessRight	True	GroupUserAccessRight	Droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
identifier	True	string	Identificateur du principal
principalType	True	PrincipalType	Type principal
displayName		string	Nom d’affichage du principal
emailAddress		string	Adresse e-mail de l’utilisateur
graphId		string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
profile		ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
userType		string	Type de l’utilisateur.

Réponses

Nom	Type	Description
200 OK		Ok

Exemples

Add security group to workspace example

Add service principal to workspace example

Add user to group example

Add security group to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Sample Response

Status code:

200

Add service principal to workspace example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Sample Response

Status code:

200

Add user to group example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users

Request Body

{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Sample Response

Status code:

200

Définitions

Nom	Description
GroupUser	Un utilisateur Power BI ayant accès à l’espace de travail
GroupUserAccessRight	Droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
PrincipalType	Type principal
ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.

GroupUser

Un utilisateur Power BI ayant accès à l’espace de travail

Nom	Type	Description
displayName	string	Nom d’affichage du principal
emailAddress	string	Adresse e-mail de l’utilisateur
graphId	string	Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
groupUserAccessRight	GroupUserAccessRight	Droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
identifier	string	Identificateur du principal
principalType	PrincipalType	Type principal
profile	ServicePrincipalProfile	Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
userType	string	Type de l’utilisateur.

GroupUserAccessRight

Droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail

Nom	Type	Description
Admin	string	Droits d’administrateur sur le contenu de l’espace de travail
Contributor	string	Lire et explorer l’accès (ReadExplore) au contenu de l’espace de travail
Member	string	Lire, partager et explorer (ReadReshareExplore) les droits d’accès au contenu de l’espace de travail
None	string	Aucun accès au contenu de l’espace de travail
Viewer	string	Accès en lecture seule au contenu de l’espace de travail

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type principal. Utilisez pour un accès de niveau organization entier.
User	string	Type de principal d’utilisateur

ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.

Nom	Type	Description
displayName	string	Nom du profil principal de service
id	string	ID de profil du principal de service