Embed Token - Dashboards GenerateTokenInGroup

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Menghasilkan token semat untuk melihat dasbor yang ditentukan dari ruang kerja yang ditentukan.

Penting

Panggilan API ini hanya relevan dengan sematan untuk skenario pelanggan Anda . Untuk mempelajari selengkapnya tentang menggunakan API ini, lihat Pertimbangan saat membuat token semat.

Izin

Saat menggunakan perwakilan layanan untuk autentikasi, lihat Menyematkan konten Power BI dengan perwakilan layanan dan Pertimbangan dan batasan.
Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: Profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Semua hal berikut:

Dashboard.ReadWrite.All atau Dashboard.Read.All
Report.ReadWrite.All atau Report.Read.All
Dataset.ReadWrite.All atau Dataset.Read.All

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}/GenerateToken

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
dashboardId	path	True	string uuid	ID dasbor
groupId	path	True	string uuid	ID ruang kerja

Isi Permintaan

Nama	Jenis	Deskripsi
accessLevel	TokenAccessLevel	Tingkat akses yang diperlukan untuk pembuatan token semat
allowSaveAs	boolean	Apakah laporan yang disematkan dapat disimpan sebagai laporan baru. Nilai defaultnya adalah `false`. Hanya berlaku saat Anda membuat token semat untuk penyematan laporan.
datasetId	string	ID himpunan data yang digunakan untuk pembuatan laporan. Hanya berlaku saat Anda membuat token semat untuk pembuatan laporan.
identities	EffectiveIdentity[]	Daftar identitas yang digunakan untuk aturan keamanan tingkat baris
lifetimeInMinutes	integer	Masa pakai maksimum token dalam hitungan menit, mulai dari waktu pembuatannya. Dapat digunakan untuk mempersingkat waktu kedaluwarsa token, tetapi tidak untuk memperpanjangnya. Nilai harus berupa bilangan bulat positif. Nol (0) setara dengan null dan akan diabaikan, menghasilkan waktu kedaluwarsa default.

Respons

Nama	Jenis	Deskripsi
200 OK	EmbedToken	OK

Contoh

Generate a dashboard embed token using an effective identity with an identity blob example

Generate a dashboard embed token with multiple identities example

Generate a dashboard embed token using an effective identity with an identity blob example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/GenerateToken

Request Body

{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

Sample Response

Status code:: 200

{
  "token": "H4sI....AAA=",
  "tokenId": "49ae3742-54c0-4c29-af52-619ff93b5c80",
  "expiration": "2018-07-29T17:58:19Z"
}

Generate a dashboard embed token with multiple identities example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/GenerateToken

Request Body

{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    },
    {
      "username": "john_contoso",
      "roles": [
        "product"
      ],
      "datasets": [
        "a8b062ca-5730-468f-9df7-43c2ba76bf5e"
      ]
    }
  ]
}

Sample Response

Status code:: 200

{
  "token": "H4sI....AAA=",
  "tokenId": "49ae3742-54c0-4c29-af52-619ff93b5c80",
  "expiration": "2018-07-29T17:58:19Z"
}

Definisi

Nama	Deskripsi
EffectiveIdentity	Menentukan identitas dan peran pengguna. Untuk informasi selengkapnya, lihat Keamanan tingkat baris dengan Power BI Embedded.
EmbedToken	Token semat Power BI
GenerateTokenRequest	Power BI Menghasilkan Permintaan Token
IdentityBlob	Blob untuk menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL
TokenAccessLevel	Tingkat akses yang diperlukan untuk pembuatan token semat

EffectiveIdentity

Menentukan identitas dan peran pengguna. Untuk informasi selengkapnya, lihat Keamanan tingkat baris dengan Power BI Embedded.

Nama	Jenis	Deskripsi
auditableContext	string	Konteks yang dapat diaudit EffectiveIdentity. Jika parameter ini disediakan dan tidak kosong, parameter ini akan mengaktifkan audit EffectiveIdentity dan nilainya akan diatur ke nama pengguna dalam catatan audit. Jika tidak, konteks EffectiveIdentity akan dihilangkan dari catatan audit GenerateToken.
customData	string	Data kustom yang digunakan untuk menerapkan aturan keamanan tingkat baris. Didukung untuk koneksi langsung ke model Azure Analysis Services dan model cloud saja.
datasets	string[]	Array himpunan data tempat identitas ini berlaku
identityBlob	IdentityBlob	Blob yang menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL.
reports	string[]	Array laporan tempat identitas ini berlaku. Hanya didukung untuk laporan paginasi.
roles	string[]	Array peran keamanan tingkat baris (RLS) dalam token yang menerapkan aturan RLS. Identitas dapat berisi hingga 50 peran. Peran dapat berisi karakter apa pun kecuali `,`, dan panjangnya tidak boleh melebihi 50 karakter.
username	string	Nama pengguna yang efektif dalam token yang menerapkan aturan keamanan tingkat baris. Untuk model lokal, nama pengguna dapat berisi alfanumerik atau salah satu karakter `.`berikut , , `-`, , `_#!`, `^`, `~`, `\\`, . `@` Untuk model cloud, nama pengguna dapat berisi karakter ASCII apa pun. Untuk salah satu model, panjang nama pengguna tidak boleh melebihi 256 karakter, dan nama pengguna tidak boleh berisi spasi.

EmbedToken

Token semat Power BI

Nama	Jenis	Deskripsi
expiration	string	Tanggal dan waktu (UTC) kedaluwarsa token
token	string	Token yang disematkan
tokenId	string	ID token unik. Melalui log audit, ID token dapat digunakan untuk menghubungkan operasi yang menggunakan token dengan operasi hasilkan.

GenerateTokenRequest

Power BI Menghasilkan Permintaan Token

Nama	Jenis	Deskripsi
accessLevel	TokenAccessLevel	Tingkat akses yang diperlukan untuk pembuatan token semat
allowSaveAs	boolean	Apakah laporan yang disematkan dapat disimpan sebagai laporan baru. Nilai defaultnya adalah `false`. Hanya berlaku saat Anda membuat token semat untuk penyematan laporan.
datasetId	string	ID himpunan data yang digunakan untuk pembuatan laporan. Hanya berlaku saat Anda membuat token semat untuk pembuatan laporan.
identities	EffectiveIdentity[]	Daftar identitas yang digunakan untuk aturan keamanan tingkat baris
lifetimeInMinutes	integer	Masa pakai maksimum token dalam hitungan menit, mulai dari waktu pembuatannya. Dapat digunakan untuk mempersingkat waktu kedaluwarsa token, tetapi tidak untuk memperpanjangnya. Nilai harus berupa bilangan bulat positif. Nol (0) setara dengan null dan akan diabaikan, menghasilkan waktu kedaluwarsa default.

IdentityBlob

Blob untuk menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL

Nama	Jenis	Deskripsi
value	string	Token akses OAuth 2.0 untuk Azure SQL

TokenAccessLevel

Tingkat akses yang diperlukan untuk pembuatan token semat

Nama	Jenis	Deskripsi
Create	string	Menunjukkan bahwa token semat yang dihasilkan memberikan izin pembuatan. Hanya berlaku saat Anda membuat token semat untuk pembuatan laporan.
Edit	string	Menunjukkan bahwa token semat yang dihasilkan memberikan izin tampilan dan edit. Hanya berlaku saat Anda membuat token semat untuk penyematan laporan.
View	string	Menunjukkan bahwa token semat yang dihasilkan memberikan izin lihat-saja

Bagikan melalui

Embed Token - Dashboards GenerateTokenInGroup

Izin

Cakupan yang Diperlukan

Parameter URI

Isi Permintaan

Respons

Contoh

Generate a dashboard embed token using an effective identity with an identity blob example

Sample Request

Sample Response

Generate a dashboard embed token with multiple identities example

Sample Request

Sample Response

Definisi

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel

Sumber Daya Tambahan: