Partager via

Groups - Add Group User

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

Accorde à 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 pour être mis à jour et peuvent ne pas être immédiatement disponibles lors de l’utilisation d’appels d’API. Pour actualiser les autorisations utilisateur, utilisez l'Actualiser les autorisations utilisateur appel d’API.
  • Chaque espace de travail est limité à un maximum de 1 000 utilisateurs ou groupes dans les rôles d’espace de travail (Administrateur, Membre, Contributeur, Visionneuse). Le nombre d’utilisateurs au sein d’un groupe n’est pas limité. La limitation couvre également les invités externes. 

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

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
 path True

string (uuid)

Identifiant de l’espace de travail

Corps de la demande

Nom Obligatoire Type Description
groupUserAccessRight True

GroupUserAccessRight

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

string

Identificateur du principal
principalType True

PrincipalType

Type de principal
displayName

string

Nom complet 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 de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.

Réponses

Nom Type Description
200 OK

D’ACCORD

Exemples

Assign administrator user access rights to a service principal example
Example

Assign administrator user access rights to a service principal example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Corps de la demande
{
  "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "groupUserAccessRight": "Admin",
  "principalType": "App"
}

Exemple de réponse

Code d’état:
200

Example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
Corps de la demande
{
  "emailAddress": "john@contoso.com",
  "groupUserAccessRight": "Admin"
}

Exemple de réponse

Code d’état:
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) qu’un utilisateur a sur l’espace de travail
PrincipalType

Type de principal
ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

GroupUser

Object

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

Nom Type Description
displayName

string

Nom complet 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) qu’un utilisateur a sur l’espace de travail
identifier

string

Identificateur du principal
principalType

PrincipalType

Type de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.

GroupUserAccessRight

Énumération

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

Valeur Description
None

Aucun accès au contenu de l’espace de travail
Member

Lire, repartager et explorer (ReadReshareExplore) des droits d’accès au contenu de l’espace de travail
Admin

Droits d’administrateur sur le contenu de l’espace de travail
Contributor

Accès en lecture et exploration (ReadExplore) au contenu de l’espace de travail
Viewer

Accès en lecture seule (lecture) au contenu de l’espace de travail

PrincipalType

Énumération

Type de principal

Valeur Description
None

Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User

Type de principal de l’utilisateur
Group

Type de principal de groupe
App

Type de principal de service

ServicePrincipalProfile

Object

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

Nom Type Description
displayName

string

Nom du profil du principal de service
id

string (uuid)

ID de profil du principal de service