Groups - Add Group User

Layanan:

Power BI REST APIs

Versi API:

v1.0

Memberi pengguna yang ditentukan izin yang ditentukan ke ruang kerja yang ditentukan.

Hak akses

Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Workspace.ReadWrite.All

Keterbatasan

• Izin pengguna untuk ruang kerja membutuhkan waktu untuk diperbarui dan mungkin tidak segera tersedia saat menggunakan panggilan API. Untuk merefresh izin pengguna, gunakan Refresh Izin Pengguna panggilan API.
• Setiap ruang kerja dibatasi hingga maksimum 1.000 pengguna atau grup dalam peran ruang kerja (Admin, Anggota, Kontributor, Penampil). Jumlah pengguna dalam grup tidak terbatas. Batasan ini juga mencakup tamu eksternal.
  
  

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
groupId	path	True	string (uuid)	ID ruang kerja

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
groupUserAccessRight	True	GroupUserAccessRight	Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja
identifier	True	string	Pengidentifikasi utama
principalType	True	PrincipalType	Jenis utama
displayName		string	Nama tampilan prinsipal
emailAddress		string	Alamat email pengguna
graphId		string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
profile		ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.
userType		string	Jenis pengguna.

Respons

Nama	Jenis	Deskripsi
200 OK		OK

Contoh

Assign administrator user access rights to a service principal example

Example

Assign administrator user access rights to a service principal example

Permintaan sampel

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

Isi Permintaan

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

Respon sampel

Kode status:

200

Example

Permintaan sampel

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

Isi Permintaan

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

Respon sampel

Kode status:

200

Definisi

Nama	Deskripsi
GroupUser	Pengguna Power BI dengan akses ke ruang kerja
GroupUserAccessRight	Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja
PrincipalType	Jenis utama
ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.

GroupUser

Objek

Pengguna Power BI dengan akses ke ruang kerja

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
groupUserAccessRight	GroupUserAccessRight	Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja
identifier	string	Pengidentifikasi utama
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.
userType	string	Jenis pengguna.

GroupUserAccessRight

Enumeration

Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja

Nilai	Deskripsi
None	Tidak ada akses ke konten ruang kerja
Member	Membaca, membentuk ulang, dan menjelajahi hak akses (ReadReshareExplore) ke konten ruang kerja
Admin	Hak administrator untuk konten ruang kerja
Contributor	Membaca dan menjelajahi akses (ReadExplore) ke konten ruang kerja
Viewer	Akses baca-saja (Baca) ke konten ruang kerja

PrincipalType

Enumeration

Jenis utama

Nilai	Deskripsi
None	Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.
User	Jenis prinsipal pengguna
Group	Jenis prinsipal grup
App	Jenis perwakilan layanan

ServicePrincipalProfile

Objek

Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.

Nama	Jenis	Deskripsi
displayName	string	Nama profil perwakilan layanan
id	string (uuid)	ID profil perwakilan layanan