Groups - Add Group User

Service:

Power BI REST APIs

API Version:

v1.0

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

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez Profils de principal de service dans Power BI Embedded.

Étendue requise

Workspace.ReadWrite.All

Limites

• Les autorisations utilisateur pour les espaces de travail prennent du temps à être mises à jour et peuvent ne pas être immédiatement disponibles lors de l’utilisation des appels d’API. Pour actualiser les autorisations utilisateur, utilisez l’appel d’API Actualiser les autorisations utilisateur .
  
  

POST https://api.powerbi.com/v1.0/myorg/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	Le 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. Concerne uniquement Power BI Embedded solution mutualisée.
userType		string	Type de l’utilisateur.

Réponses

Nom	Type	Description
200 OK		OK

Exemples

Assign administrator user access rights to a service principal example

Example

Assign administrator user access rights to a service principal example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Request Body

{
  "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "groupUserAccessRight": "Admin",
  "principalType": "App"
}

Sample Response

Status code:

200

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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	Le droit d’accès (niveau d’autorisation) d’un utilisateur sur l’espace de travail
PrincipalType	Type principal
ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

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	Le 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. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

GroupUserAccessRight

Le 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	Accès en lecture et exploration (ReadExplore) au contenu de l’espace de travail
Member	string	Lire, repartager 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 de principal. Utilisez pour un accès entier organization niveau.
User	string	Type de principal d’utilisateur

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

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