Freigeben über

Embed Token - Reports GenerateTokenInGroup

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

Generiert ein Einbettungstoken zum Anzeigen oder Bearbeiten des angegebenen Berichts aus dem angegebenen Arbeitsbereich.

Tipp

Um Einbettungstoken zu erstellen, empfiehlt es sich, die neueste API zu verwenden, Token generieren. Das Generieren von Token unterstützt zusätzliche Funktionen, z. B. das Erstellen eines Tokens für mehrere Elemente.

Wichtig

Dieser API-Aufruf ist nur für die Einbindung für Ihre Kunden Szenario relevant. Weitere Informationen zur Verwendung dieser API finden Sie unter Überlegungen beim Generieren eines Einbettungstokens.

Erlaubnisse

Erforderlicher Bereich

Alle folgenden Elemente, es sei denn, eine Anforderung gilt nicht:

  • Report.ReadWrite.All oder Report.Read.All
  • Dataset.ReadWrite.All oder Dataset.Read.All
  • Content.Create, erforderlich, wenn das allowSaveAs Flag in GenerateTokenRequest- angegeben ist

Einschränkungen

Für lokale Liveverbindungsberichte von Azure Analysis Services oder Analysis Services funktioniert das Generieren eines Einbettungstokens mit Sicherheit auf Zeilenebene nach einem Rebind-Berichtmöglicherweise nicht mehr. 

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
groupId
 path True

string (uuid)

Arbeitsbereich-ID
reportId
 path True

string (uuid)

Die Berichts-ID

Anforderungstext

Name Typ Beschreibung
accessLevel

TokenAccessLevel

Die erforderliche Zugriffsstufe für die Generierung von Einbettungstoken
allowSaveAs

boolean

Gibt an, ob ein eingebetteter Bericht als neuer Bericht gespeichert werden kann. Der Standardwert ist false. Gilt nur, wenn Sie ein Einbettungstoken für die Einbettung von Berichten generieren.
datasetId

string

Die Dataset-ID, die für die Berichtserstellung verwendet wird. Gilt nur, wenn Sie ein Einbettungstoken für die Berichtserstellung generieren.
identities

EffectiveIdentity[]

Eine Liste der Identitäten, die für Sicherheitsregeln auf Zeilenebene verwendet werden sollen
lifetimeInMinutes

integer

Die maximale Lebensdauer des Tokens in Minuten, beginnend mit dem Zeitpunkt, zu dem es generiert wurde. Kann verwendet werden, um die Ablaufzeit eines Tokens zu verkürzen, aber nicht, um es zu erweitern. Der Wert muss eine positive ganze Zahl sein. Null (0) entspricht null und wird ignoriert, was zu der Standardablaufzeit führt.

Antworten

Name Typ Beschreibung
200 OK

EmbedToken

OKAY

Beispiele

Generate a paginated report embed token using an effective identity example
Generate a report embed token for editing example. The embed token uses an effective identity.
Generate a report embed token for viewing a report and saving to a new report example
Generate a report embed token using an effective identity example
Generate a report embed token using an effective identity with an identity blob example
Generate a report embed token using an effective identity with custom data for Azure Analysis Services example
Generate a report embed token using an effective identity with multiple roles example

Generate a paginated report embed token using an effective identity example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "John Smith",
      "reports": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Beispiel für eine Antwort

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

Generate a report embed token for editing example. The embed token uses an effective identity.

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "Edit",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Beispiel für eine Antwort

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

Generate a report embed token for viewing a report and saving to a new report example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "allowSaveAs": "true"
}

Beispiel für eine Antwort

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

Generate a report embed token using an effective identity example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Beispiel für eine Antwort

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

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

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

Beispiel für eine Antwort

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

Generate a report embed token using an effective identity with custom data for Azure Analysis Services example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "customData": "john_contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Beispiel für eine Antwort

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

Generate a report embed token using an effective identity with multiple roles example

Beispielanforderung

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715/GenerateToken
Anforderungstext
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales",
        "marketing"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
EffectiveIdentity

Definiert die Benutzeridentität und -rollen. Weitere Informationen finden Sie unter Sicherheit auf Zeilenebene mit Power BI Embedded.
EmbedToken

Ein Power BI-Einbettungstoken
GenerateTokenRequest

Power BI Tokenanforderung generieren
IdentityBlob

Ein Blob zum Angeben einer Identität. Nur für Datasets mit einer DirectQuery-Verbindung mit Azure SQL unterstützt
TokenAccessLevel

Die erforderliche Zugriffsstufe für die Generierung von Einbettungstoken

EffectiveIdentity

Objekt

Definiert die Benutzeridentität und -rollen. Weitere Informationen finden Sie unter Sicherheit auf Zeilenebene mit Power BI Embedded.

Name Typ Beschreibung
auditableContext

string

Der Auditable-Kontext "EffectiveIdentity". Wenn dieser Parameter angegeben und nicht leer ist, wird die Überwachung der EffectiveIdentity aktiviert, und der Wert wird auf den Benutzernamen im Überwachungsdatensatz festgelegt. Andernfalls wird der EffectiveIdentity-Kontext aus dem GenerateToken-Überwachungsdatensatz weggelassen.
customData

string

Benutzerdefinierte Daten, die zum Anwenden von Sicherheitsregeln auf Zeilenebene verwendet werden. Wird nur für live-Verbindungen mit Azure Analysis Services-Modellen und Cloudmodellen unterstützt.
datasets

string[]

Ein Array von Datasets, für die diese Identität gilt
identityBlob

IdentityBlob

Ein Blob, das eine Identitätangibt. Wird nur für Datasets mit einer DirectQuery-Verbindung mit Azure SQL unterstützt.
reports

string[]

Ein Array von Berichten, für die diese Identität gilt. Wird nur für paginierte Berichte unterstützt.
roles

string[]

Ein Array von Rollen auf Zeilenebene (RLS) innerhalb eines Tokens, das RLS-Regeln anwendet. Eine Identität kann bis zu 50 Rollen enthalten. Eine Rolle kann ein beliebiges Zeichen mit Ausnahme von ,enthalten, und seine Länge darf 50 Zeichen nicht überschreiten.
username

string

Der effektive Benutzername in einem Token, das Sicherheitsregeln auf Zeilenebene anwendet. Für ein lokales Modell kann der Benutzername alphanumerisch oder eines der folgenden Zeichen ., -, _, !, #, ^, ~, \\, @. Bei Cloudmodellen kann der Benutzername ein beliebiges ASCII-Zeichen enthalten. Für beide Modelle darf die Länge des Benutzernamens 256 Zeichen nicht überschreiten, und der Benutzername darf keine Leerzeichen enthalten.

EmbedToken

Objekt

Ein Power BI-Einbettungstoken

Name Typ Beschreibung
expiration

string (date-time)

Datum und Uhrzeit (UTC) des Tokenablaufs
token

string

Das Einbettungstoken
tokenId

string (uuid)

Die eindeutige Token-ID. Mithilfe von Überwachungsprotokollen kann die Token-ID verwendet werden, um Vorgänge zu korrelieren, die das Token mit dem Generieren-Vorgang verwenden.

GenerateTokenRequest

Objekt

Power BI Tokenanforderung generieren

Name Typ Beschreibung
accessLevel

TokenAccessLevel

Die erforderliche Zugriffsstufe für die Generierung von Einbettungstoken
allowSaveAs

boolean

Gibt an, ob ein eingebetteter Bericht als neuer Bericht gespeichert werden kann. Der Standardwert ist false. Gilt nur, wenn Sie ein Einbettungstoken für die Einbettung von Berichten generieren.
datasetId

string

Die Dataset-ID, die für die Berichtserstellung verwendet wird. Gilt nur, wenn Sie ein Einbettungstoken für die Berichtserstellung generieren.
identities

EffectiveIdentity[]

Eine Liste der Identitäten, die für Sicherheitsregeln auf Zeilenebene verwendet werden sollen
lifetimeInMinutes

integer

Die maximale Lebensdauer des Tokens in Minuten, beginnend mit dem Zeitpunkt, zu dem es generiert wurde. Kann verwendet werden, um die Ablaufzeit eines Tokens zu verkürzen, aber nicht, um es zu erweitern. Der Wert muss eine positive ganze Zahl sein. Null (0) entspricht null und wird ignoriert, was zu der Standardablaufzeit führt.

IdentityBlob

Objekt

Ein Blob zum Angeben einer Identität. Nur für Datasets mit einer DirectQuery-Verbindung mit Azure SQL unterstützt

Name Typ Beschreibung
value

string

Ein OAuth 2.0-Zugriffstoken für Azure SQL

TokenAccessLevel

Enumeration

Die erforderliche Zugriffsstufe für die Generierung von Einbettungstoken

Wert Beschreibung
View

Gibt an, dass das generierte Einbettungstoken schreibgeschützte Berechtigung erteilt
Edit

Gibt an, dass das generierte Einbettungstoken Anzeige- und Bearbeitungsberechtigungen gewährt. Gilt nur, wenn Sie ein Einbettungstoken für die Einbettung von Berichten generieren.
Create

Gibt an, dass das generierte Einbettungstoken die Berechtigung zum Erstellen gewährt. Gilt nur, wenn Sie ein Einbettungstoken für die Berichtserstellung generieren.