Partager via

Admin - Groups AddUserAsAdmin

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

Accorde 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.

Permissions

L’utilisateur doit être administrateur fabric.

Étendue requise

Tenant.ReadWrite.All

Limites

  • Maximum 200 requêtes par heure.
  • 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/admin/groups/{groupId}/users

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
 path True

string (uuid)

ID 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 la solution multilocataire Power BI Embedded.
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

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users
Corps de la demande
{
  "identifier": "ece007fa-2f19-4df1-bdd5-539881ec5f83",
  "principalType": "Group",
  "groupUserAccessRight": "Member"
}

Exemple de réponse

Code d’état:
200

Add service principal to workspace example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/users
Corps de la demande
{
  "identifier": "84c468ad-12f1-471e-af6f-0999da422391",
  "principalType": "App",
  "groupUserAccessRight": "Viewer"
}

Exemple de réponse

Code d’état:
200

Add user to group example

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/admin/groups/206d27ca-94e8-4a69-855b-5c32bdd458a8/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 la 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 la 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 la 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