Freigeben über

Groups - Add Group User

Dienst:
Power BI REST APIs
API-Version:
v1.0

Gewährt dem angegebenen Benutzer die angegebenen Berechtigungen für den angegebenen Arbeitsbereich.

Erlaubnisse

Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter: Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Workspace.ReadWrite.All

Einschränkungen

  • Benutzerberechtigungen für Arbeitsbereiche nehmen Zeit in Anspruch, um aktualisiert zu werden und sind möglicherweise nicht sofort verfügbar, wenn API-Aufrufe verwendet werden. Verwenden Sie zum Aktualisieren von Benutzerberechtigungen den Aktualisieren von Benutzerberechtigungen API-Aufrufs.
  • Jeder Arbeitsbereich ist auf maximal 1.000 Benutzer oder Gruppen in Arbeitsbereichsrollen beschränkt (Administrator, Mitglied, Mitwirkender, Viewer). Die Anzahl der Benutzer innerhalb einer Gruppe ist nicht beschränkt. Die Einschränkung deckt auch externe Gäste ab. 

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
groupId
 path True

string (uuid)

Arbeitsbereich-ID

Anforderungstext

Name Erforderlich Typ Beschreibung
groupUserAccessRight True

GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt
identifier True

string

Bezeichner des Prinzipals
principalType True

PrincipalType

Der Prinzipaltyp
displayName

string

Anzeigename des Prinzipals
emailAddress

string

E-Mail-Adresse des Benutzers
graphId

string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

Antworten

Name Typ Beschreibung
200 OK

OKAY

Beispiele

Assign administrator user access rights to a service principal example
Example

Assign administrator user access rights to a service principal example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200

Definitionen

Name Beschreibung
GroupUser

Ein Power BI-Benutzer mit Zugriff auf den Arbeitsbereich
GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt
PrincipalType

Der Prinzipaltyp
ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.

GroupUser

Objekt

Ein Power BI-Benutzer mit Zugriff auf den Arbeitsbereich

Name Typ Beschreibung
displayName

string

Anzeigename des Prinzipals
emailAddress

string

E-Mail-Adresse des Benutzers
graphId

string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
groupUserAccessRight

GroupUserAccessRight

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt
identifier

string

Bezeichner des Prinzipals
principalType

PrincipalType

Der Prinzipaltyp
profile

ServicePrincipalProfile

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType

string

Typ des Benutzers.

GroupUserAccessRight

Enumeration

Das Zugriffsrecht (Berechtigungsstufe), über das ein Benutzer im Arbeitsbereich verfügt

Wert Beschreibung
None

Kein Zugriff auf Arbeitsbereichsinhalte
Member

Lese-, Freigabe- und Erkundungsrechte (ReadReshareExplore) für Arbeitsbereichsinhalte
Admin

Administratorrechte für Arbeitsbereichsinhalte
Contributor

Lese- und Erkundungszugriff (ReadExplore) auf Arbeitsbereichsinhalte
Viewer

Schreibgeschützter (Lesezugriff) auf Arbeitsbereichsinhalte

PrincipalType

Enumeration

Der Prinzipaltyp

Wert Beschreibung
None

Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User

Benutzerprinzipaltyp
Group

Gruppenprinzipaltyp
App

Dienstprinzipaltyp

ServicePrincipalProfile

Objekt

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.

Name Typ Beschreibung
displayName

string

Der Dienstprinzipalprofilname
id

string (uuid)

Die Dienstprinzipalprofil-ID