Embed Token - Dashboards GenerateTokenInGroup

  • Başvuru
Service:
Power BI REST APIs
API Version:
v1.0

Belirtilen çalışma alanından belirtilen panoyu görüntülemek için bir ekleme belirteci oluşturur.

Önemli

Bu API çağrısı yalnızca müşterileriniz için ekleme senaryosuyla ilgilidir. Bu API'yi kullanma hakkında daha fazla bilgi edinmek için bkz. Ekleme belirteci oluştururken dikkat edilmesi gerekenler.

İzinler

Gerekli Kapsam

Aşağıdakilerin tümü:

  • Dashboard.ReadWrite.All veya Dashboard.Read.All
  • Report.ReadWrite.All veya Report.Read.All
  • Dataset.ReadWrite.All veya Dataset.Read.All

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

URI Parametreleri

Name İçinde Gerekli Tür Description
dashboardId
 path True

string

uuid

Pano kimliği
groupId
 path True

string

uuid

Çalışma alanı kimliği

İstek Gövdesi

Name Tür Description
accessLevel

TokenAccessLevel

Ekleme belirteci oluşturma için gerekli erişim düzeyi
allowSaveAs

boolean

Eklenmiş bir raporun yeni rapor olarak kaydedilip kaydedilemeyeceği. false varsayılan değerdir. Yalnızca rapor ekleme için ekleme belirteci oluşturduğunuzda geçerlidir.
datasetId

string

Rapor oluşturmak için kullanılan veri kümesi kimliği. Yalnızca rapor oluşturmak için ekleme belirteci oluşturduğunuzda geçerlidir.
identities

EffectiveIdentity[]

Satır düzeyi güvenlik kuralları için kullanılacak kimliklerin listesi
lifetimeInMinutes

integer

Belirtecin oluşturulduğu zamandan başlayarak dakika cinsinden en uzun yaşam süresi. Belirtecin sona erme süresini kısaltmak için kullanılabilir, ancak uzatmak için kullanılamaz. Değer pozitif bir tamsayı olmalıdır. Sıfır (0) null ile eşdeğerdir ve yoksayılır ve bu da varsayılan süre sonu süresiyle sonuçlanır.

Yanıtlar

Name Tür Description
200 OK

EmbedToken

Tamam

Örnekler

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"
}

Tanımlar

Name Description
EffectiveIdentity

Kullanıcı kimliğini ve rollerini tanımlar. Daha fazla bilgi için bkz. Power BI Embedded ile satır düzeyi güvenlik.
EmbedToken

Power BI ekleme belirteci
GenerateTokenRequest

Power BI Belirteç İsteği Oluşturma
IdentityBlob

Kimlik belirtmek için bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir
TokenAccessLevel

Ekleme belirteci oluşturma için gerekli erişim düzeyi

EffectiveIdentity

Kullanıcı kimliğini ve rollerini tanımlar. Daha fazla bilgi için bkz. Power BI Embedded ile satır düzeyi güvenlik.

Name Tür Description
auditableContext

string

EffectiveIdentity denetlenebilir bağlamı. Bu parametre sağlanır ve boş değilse EffectiveIdentity denetimini etkinleştirir ve değeri denetim kaydındaki kullanıcı adına ayarlanır. Aksi takdirde EffectiveIdentity bağlamı GenerateToken denetim kaydından atlanır.
customData

string

Satır düzeyi güvenlik kurallarını uygulamak için kullanılan özel veriler. Yalnızca Azure Analysis Services modellerine ve bulut modellerine canlı bağlantı için desteklenir.
datasets

string[]

Bu kimliğin geçerli olduğu bir veri kümesi dizisi
identityBlob

IdentityBlob

Kimliği belirten bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir.
reports

string[]

Bu kimliğin geçerli olduğu bir rapor dizisi. Yalnızca sayfalandırılmış raporlar için desteklenir.
roles

string[]

RLS kurallarını uygulayan bir belirteç içindeki satır düzeyi güvenlik (RLS) rolleri dizisi. Bir kimlik en fazla 50 rol içerebilir. Bir rol dışında ,herhangi bir karakter içerebilir ve uzunluğu 50 karakteri aşmamalıdır.
username

string

Satır düzeyi güvenlik kuralları uygulayan bir belirteç içindeki geçerli kullanıcı adı. Şirket içi model için kullanıcı adı alfasayısal veya şu karakterlerden .herhangi birini içerebilir: , -, !_, , #, ^, ~, , \\, . @ Bulut modelleri için kullanıcı adı herhangi bir ASCII karakteri içerebilir. Her iki model için de kullanıcı adı uzunluğu 256 karakteri aşmamalıdır ve kullanıcı adı boşluk içermemelidir.

EmbedToken

Power BI ekleme belirteci

Name Tür Description
expiration

string

Belirtecin sona erme tarihi ve saati (UTC)
token

string

Ekleme belirteci
tokenId

string

Benzersiz belirteç kimliği. Denetim günlükleri aracılığıyla belirteç kimliği, belirteci oluşturma işlemiyle kullanan işlemleri ilişkilendirmek için kullanılabilir.

GenerateTokenRequest

Power BI Belirteç İsteği Oluşturma

Name Tür Description
accessLevel

TokenAccessLevel

Ekleme belirteci oluşturma için gerekli erişim düzeyi
allowSaveAs

boolean

Eklenmiş bir raporun yeni rapor olarak kaydedilip kaydedilemeyeceği. false varsayılan değerdir. Yalnızca rapor ekleme için ekleme belirteci oluşturduğunuzda geçerlidir.
datasetId

string

Rapor oluşturmak için kullanılan veri kümesi kimliği. Yalnızca rapor oluşturmak için ekleme belirteci oluşturduğunuzda geçerlidir.
identities

EffectiveIdentity[]

Satır düzeyi güvenlik kuralları için kullanılacak kimliklerin listesi
lifetimeInMinutes

integer

Belirtecin oluşturulduğu zamandan başlayarak dakika cinsinden en uzun yaşam süresi. Belirtecin sona erme süresini kısaltmak için kullanılabilir, ancak uzatmak için kullanılamaz. Değer pozitif bir tamsayı olmalıdır. Sıfır (0) null ile eşdeğerdir ve yoksayılır ve bu da varsayılan süre sonu süresiyle sonuçlanır.

IdentityBlob

Kimlik belirtmek için bir blob. Yalnızca Azure SQL DirectQuery bağlantısı olan veri kümeleri için desteklenir

Name Tür Description
value

string

Azure SQL için OAuth 2.0 erişim belirteci

TokenAccessLevel

Ekleme belirteci oluşturma için gerekli erişim düzeyi

Name Tür Description
Create

string

Oluşturulan ekleme belirtecinin oluşturma iznini verdiğinden emindir. Yalnızca rapor oluşturmak için ekleme belirteci oluşturduğunuzda geçerlidir.
Edit

string

Oluşturulan ekleme belirtecinin görüntüleme ve düzenleme izinleri olduğunu gösterir. Yalnızca rapor ekleme için ekleme belirteci oluşturduğunuzda geçerlidir.
View

string

Oluşturulan ekleme belirtecinin yalnızca görüntüleme izni verdiğinden emin olur