Sdílet prostřednictvím


Embed Token - Tiles GenerateTokenInGroup

Vygeneruje token pro vložení pro zobrazení zadané dlaždice ze zadaného pracovního prostoru.

Důležité

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

Oprávnění

Požadovaný obor

Všechno z tohoto:

  • 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}/tiles/{tileId}/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

tileId
path True

string

uuid

ID dlaždice

Text požadavku

Name Typ Description
accessLevel

TokenAccessLevel

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

allowSaveAs

boolean

Určuje, zda lze vloženou sestavu uložit jako novou sestavu. Výchozí hodnota je false. Platí pouze v případě, že vygenerujete token pro vložení sestavy.

datasetId

string

ID datové sady použité k vytvoření sestavy Platí pouze 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 od jeho vygenerování. Dá se použít ke zkrácení doby vypršení platnosti tokenu, ale ne k jejímu prodlouž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 tile embed token using an effective identity example
Generate a tile embed token using an effective identity with an identity blob example
Generate a tile embed token using an effective identity with custom data for Azure Analysis Services example

Generate a tile embed token using an effective identity example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/GenerateToken
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Sample Response

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

Generate a tile 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/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/GenerateToken
{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

Sample Response

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

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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/GenerateToken
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "customData": "john_contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Sample Response

{
  "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ů s Power BI Embedded.

EmbedToken

Token power BI pro vložení

GenerateTokenRequest

Žádost o vygenerování tokenu Power BI

IdentityBlob

Objekt blob pro zadání identity. Podporováno pouze 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

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

Name Typ Description
auditableContext

string

Auditovatelný kontext EffectiveIdentity. Pokud je tento parametr zadaný a není prázdný, umožní auditování effectiveidentity a jeho hodnota se nastaví na uživatelské jméno v záznamu auditu. V opačném případě se kontext EffectiveIdentity ze záznamu auditu GenerateToken vynechá.

customData

string

Vlastní data , která se používají k použití pravidel zabezpečení na úrovni řádků. Podporuje se pouze pro ž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 identitu. Podporuje se pouze pro datové sady s připojením DirectQuery k Azure SQL.

reports

string[]

Pole sestav, pro které se tato identita vztahuje. Podporováno pouze pro stránkované sestavy.

roles

string[]

Pole rolí zabezpečení na úrovni řádků (RLS) v rámci 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 její délka nesmí překročit 50 znaků.

username

string

Efektivní uživatelské jméno v rámci tokenu, které používá pravidla zabezpečení na úrovni řádků. V případě místního modelu může uživatelské jméno obsahovat alfanumerické znaky nebo některý 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

Token power BI pro vložení

Name Typ Description
expiration

string

Datum a čas (UTC) vypršení platnosti tokenu

token

string

Token pro vložení

tokenId

string

Jedinečné ID tokenu. Prostřednictvím protokolů auditu je možné ID tokenu použít ke korelaci operací, které token používají, s operací generování.

GenerateTokenRequest

Žá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

Určuje, zda lze vloženou sestavu uložit jako novou sestavu. Výchozí hodnota je false. Platí pouze v případě, že vygenerujete token pro vložení sestavy.

datasetId

string

ID datové sady použité k vytvoření sestavy Platí pouze 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 od jeho vygenerování. Dá se použít ke zkrácení doby vypršení platnosti tokenu, ale ne k jejímu prodlouž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 blob pro zadání identity. Podporováno pouze 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

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

Name Typ Description
Create

string

Označuje, že vygenerovaný token pro vložení uděluje oprávnění k vytvoření. Platí pouze v případě, že vygenerujete token pro vložení pro vytvoření sestavy.

Edit

string

Označuje, že vygenerovaný token pro vložení uděluje oprávnění k zobrazení a úpravám. Platí pouze v případě, že vygenerujete token pro vložení sestavy.

View

string

Označuje, že vygenerovaný token pro vložení uděluje oprávnění jen pro zobrazení.