Embed Token - Dashboards GenerateTokenInGroup

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

Vygeneruje token pro vložení pro zobrazení zadaného řídicího panelu ze zadaného pracovního prostoru.

Důležité

Toto volání rozhraní API je relevantní jenom pro vložení pro zákazníky scénář. Další informace o používání tohoto rozhraní API najdete v tématu Důležité informace o generování tokenu pro vložení.

Dovolení

Při použití instančního objektu pro ověřování se podívejte na Vložení obsahu Power BI s instančního objektu a důležité informace a omezení.
Toto volání rozhraní API může volat instanční profil. Další informace najdete v tématu: profily instančního objektu v Power BI Embedded.

Požadovaný obor

Všechny tyto možnosti:

Dashboard.ReadWrite.All nebo Dashboard.Read.All
Report.ReadWrite.All nebo Report.Read.All
Dataset.ReadWrite.All nebo Dataset.Read.All

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dashboardId	path	True	string (uuid)	ID řídicího panelu
groupId	path	True	string (uuid)	ID pracovního prostoru

Text požadavku

Name	Typ	Description
accessLevel	TokenAccessLevel	Požadovaná úroveň přístupu pro generování tokenů pro vložení
allowSaveAs	boolean	Zda lze vloženou sestavu uložit jako novou sestavu. Výchozí hodnota je `false`. Platí jenom v případě, že vygenerujete token pro vložení sestavy.
datasetId	string	ID datové sady použité k vytvoření sestavy. Platí jenom v případě, že vygenerujete token pro vložení pro vytvoření sestavy.
identities	EffectiveIdentity[]	Seznam identit, které se mají použít pro pravidla zabezpečení na úrovni řádků
lifetimeInMinutes	integer	Maximální životnost tokenu v minutách počínaje časem vygenerování tokenu. Lze použít ke zkrácení doby vypršení platnosti tokenu, ale ne k jeho rozšíření. Hodnota musí být kladné celé číslo. Nula (0) je ekvivalentní hodnotě null a bude ignorována, což vede k výchozímu času vypršení platnosti.

Odpovědi

Name	Typ	Description
200 OK	EmbedToken	OK

Příklady

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

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Text požadavku

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
EffectiveIdentity	Definuje identitu a role uživatele. Další informace najdete v tématu zabezpečení na úrovni řádků pomocíPower BI Embedded .
EmbedToken	Token pro vložení Power BI
GenerateTokenRequest	Žádost o vygenerování tokenu Power BI
IdentityBlob	Objekt blob pro zadání identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.
TokenAccessLevel	Požadovaná úroveň přístupu pro generování tokenů pro vložení

EffectiveIdentity

Objekt

Definuje identitu a role uživatele. Další informace najdete v tématu zabezpečení na úrovni řádků pomocíPower BI Embedded .

Name	Typ	Description
auditableContext	string	Auditovatelný kontext EffectiveIdentity. Pokud je tento parametr zadaný a není prázdný, povolí auditování EffectiveIdentity a jeho hodnota se nastaví na uživatelské jméno v záznamu auditu. V opačném případě bude kontext EffectiveIdentity vynechán ze záznamu auditu GenerateToken.
customData	string	vlastních dat, která slouží k použití pravidel zabezpečení na úrovni řádků. Podporuje se pouze živé připojení k modelům azure Analysis Services a cloudovým modelům.
datasets	string[]	Pole datových sad, pro které se tato identita vztahuje
identityBlob	IdentityBlob	Objekt blob, který určuje identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.
reports	string[]	Pole sestav, pro které tato identita platí. Podporuje se jenom pro stránkované sestavy.
roles	string[]	Pole rolí zabezpečení na úrovni řádků (RLS) v tokenu, který používá pravidla zabezpečení na úrovni řádků. Identita může obsahovat až 50 rolí. Role může obsahovat libovolný znak kromě `,`a jeho délka nesmí překročit 50 znaků.
username	string	Efektivní uživatelské jméno v tokenu, které používá pravidla zabezpečení na úrovni řádků. U místního modelu může uživatelské jméno obsahovat alfanumerické nebo libovolné z následujících znaků `.`, `-`, `_`, `!`, `#`, `^`, `~`, `\\`, `@`. U cloudových modelů může uživatelské jméno obsahovat libovolný znak ASCII. U obou modelů nesmí délka uživatelského jména překročit 256 znaků a uživatelské jméno nesmí obsahovat mezery.

EmbedToken

Objekt

Token pro vložení Power BI

Name	Typ	Description
expiration	string (date-time)	Datum a čas (UTC) vypršení platnosti tokenu
token	string	Token pro vložení
tokenId	string (uuid)	Jedinečné ID tokenu. Prostřednictvím protokolů auditu lze ID tokenu použít ke korelaci operací, které token používají s operací generování.

GenerateTokenRequest

Objekt

Žádost o vygenerování tokenu Power BI

Name	Typ	Description
accessLevel	TokenAccessLevel	Požadovaná úroveň přístupu pro generování tokenů pro vložení
allowSaveAs	boolean	Zda lze vloženou sestavu uložit jako novou sestavu. Výchozí hodnota je `false`. Platí jenom v případě, že vygenerujete token pro vložení sestavy.
datasetId	string	ID datové sady použité k vytvoření sestavy. Platí jenom v případě, že vygenerujete token pro vložení pro vytvoření sestavy.
identities	EffectiveIdentity[]	Seznam identit, které se mají použít pro pravidla zabezpečení na úrovni řádků
lifetimeInMinutes	integer	Maximální životnost tokenu v minutách počínaje časem vygenerování tokenu. Lze použít ke zkrácení doby vypršení platnosti tokenu, ale ne k jeho rozšíření. Hodnota musí být kladné celé číslo. Nula (0) je ekvivalentní hodnotě null a bude ignorována, což vede k výchozímu času vypršení platnosti.

IdentityBlob

Objekt

Objekt blob pro zadání identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.

Name	Typ	Description
value	string	Přístupový token OAuth 2.0 pro Azure SQL

TokenAccessLevel

Výčet

Požadovaná úroveň přístupu pro generování tokenů pro vložení

Hodnota	Description
View	Označuje, že vygenerovaný token pro vložení uděluje oprávnění jen pro zobrazení.
Edit	Označuje, že vygenerovaný token pro vložení uděluje oprávnění k zobrazení a úpravám. Platí jenom v případě, že vygenerujete token pro vložení sestavy.
Create	Označuje, že vygenerovaný token pro vložení uděluje oprávnění k vytvoření. Platí jenom v případě, že vygenerujete token pro vložení pro vytvoření sestavy.

Sdílet prostřednictvím

Embed Token - Dashboards GenerateTokenInGroup

Dovolení

Požadovaný obor

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

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

Ukázkový požadavek

Ukázková odpověď

Generate a dashboard embed token with multiple identities example

Ukázkový požadavek

Ukázková odpověď

Definice

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel