Embed Token - Dashboards GenerateTokenInGroup

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Generuje token osadzania, aby wyświetlić określony pulpit nawigacyjny z określonego obszaru roboczego.

Ważne

To wywołanie interfejsu API ma zastosowanie tylko do scenariusza osadzania dla klientów . Aby dowiedzieć się więcej na temat korzystania z tego interfejsu API, zobacz Zagadnienia dotyczące generowania tokenu osadzania.

Uprawnienia

W przypadku używania jednostki usługi do uwierzytelniania zapoznaj się z tematem Osadzanie zawartości usługi Power BI przy użyciu jednostki usługi oraz zagadnień i ograniczeń.
To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

Wymagany zakres

Wszystkie następujące elementy:

Dashboard.ReadWrite.All lub Dashboard.Read.All
Report.ReadWrite.All lub Report.Read.All
Dataset.ReadWrite.All lub Dataset.Read.All

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dashboardId	path	True	string uuid	Identyfikator pulpitu nawigacyjnego
groupId	path	True	string uuid	Identyfikator obszaru roboczego

Treść żądania

Nazwa	Typ	Opis
accessLevel	TokenAccessLevel	Wymagany poziom dostępu do generowania tokenu osadzania
allowSaveAs	boolean	Czy osadzony raport można zapisać jako nowy raport. Wartość domyślna to `false`. Ma zastosowanie tylko w przypadku generowania tokenu osadzania raportu.
datasetId	string	Identyfikator zestawu danych używany do tworzenia raportu. Ma zastosowanie tylko w przypadku generowania tokenu osadzania na potrzeby tworzenia raportu.
identities	EffectiveIdentity[]	Lista tożsamości do użycia dla reguł zabezpieczeń na poziomie wiersza
lifetimeInMinutes	integer	Maksymalny okres istnienia tokenu w minutach, począwszy od czasu wygenerowania. Można użyć do skrócenia czasu wygaśnięcia tokenu, ale nie do jego rozszerzenia. Wartość musi być dodatnią liczbą całkowitą. Zero (0) jest równoważne wartości null i zostanie zignorowane, co spowoduje domyślny czas wygaśnięcia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EmbedToken	OK

Przykłady

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

Definicje

Nazwa	Opis
EffectiveIdentity	Definiuje tożsamość użytkownika i role. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza z Power BI Embedded.
EmbedToken	Token osadzania usługi Power BI
GenerateTokenRequest	Żądanie generowania tokenu w usłudze Power BI
IdentityBlob	Obiekt blob określający tożsamość. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z Azure SQL
TokenAccessLevel	Wymagany poziom dostępu do generowania tokenu osadzania

EffectiveIdentity

Definiuje tożsamość użytkownika i role. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza z Power BI Embedded.

Nazwa	Typ	Opis
auditableContext	string	Kontekst z możliwością inspekcji EffectiveIdentity. Jeśli ten parametr jest podany i nie jest pusty, włączy inspekcję wartości EffectiveIdentity, a jej wartość zostanie ustawiona na nazwę użytkownika w rekordzie inspekcji. W przeciwnym razie kontekst EffectiveIdentity zostanie pominięty z rekordu inspekcji GenerateToken.
customData	string	Niestandardowe dane używane do stosowania reguł zabezpieczeń na poziomie wiersza. Obsługiwane w przypadku połączeń na żywo tylko z modelami Azure Analysis Services i modelami w chmurze.
datasets	string[]	Tablica zestawów danych, dla których ta tożsamość ma zastosowanie
identityBlob	IdentityBlob	Obiekt blob określający tożsamość. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z Azure SQL.
reports	string[]	Tablica raportów, dla których ta tożsamość ma zastosowanie. Obsługiwane tylko w przypadku raportów podzielonych na strony.
roles	string[]	Tablica ról zabezpieczeń na poziomie wiersza (RLS) w tokenie, który stosuje reguły zabezpieczeń na poziomie wiersza. Tożsamość może zawierać maksymalnie 50 ról. Rola może zawierać dowolny znak z wyjątkiem `,`znaku , a jego długość nie może przekraczać 50 znaków.
username	string	Obowiązująca nazwa użytkownika w tokenie, który stosuje reguły zabezpieczeń na poziomie wiersza. W przypadku modelu lokalnego nazwa użytkownika może zawierać alfanumeryczne lub dowolne z następujących znaków`.`, , `#-~_@!^\\`. W przypadku modeli w chmurze nazwa użytkownika może zawierać dowolny znak ASCII. W przypadku obu modeli długość nazwy użytkownika nie może przekraczać 256 znaków, a nazwa użytkownika nie powinna zawierać spacji.

EmbedToken

Token osadzania usługi Power BI

Nazwa	Typ	Opis
expiration	string	Data i godzina wygaśnięcia tokenu (UTC)
token	string	Token osadzania
tokenId	string	Unikatowy identyfikator tokenu. Za pomocą dzienników inspekcji identyfikator tokenu może służyć do korelowania operacji, które używają tokenu z operacją generowania.

GenerateTokenRequest

Żądanie generowania tokenu w usłudze Power BI

Nazwa	Typ	Opis
accessLevel	TokenAccessLevel	Wymagany poziom dostępu do generowania tokenu osadzania
allowSaveAs	boolean	Czy osadzony raport można zapisać jako nowy raport. Wartość domyślna to `false`. Ma zastosowanie tylko w przypadku generowania tokenu osadzania raportu.
datasetId	string	Identyfikator zestawu danych używany do tworzenia raportu. Ma zastosowanie tylko w przypadku generowania tokenu osadzania na potrzeby tworzenia raportu.
identities	EffectiveIdentity[]	Lista tożsamości do użycia dla reguł zabezpieczeń na poziomie wiersza
lifetimeInMinutes	integer	Maksymalny okres istnienia tokenu w minutach, począwszy od czasu wygenerowania. Można użyć do skrócenia czasu wygaśnięcia tokenu, ale nie do jego rozszerzenia. Wartość musi być dodatnią liczbą całkowitą. Zero (0) jest równoważne wartości null i zostanie zignorowane, co spowoduje domyślny czas wygaśnięcia.

IdentityBlob

Obiekt blob określający tożsamość. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z Azure SQL

Nazwa	Typ	Opis
value	string	Token dostępu OAuth 2.0 dla Azure SQL

TokenAccessLevel

Wymagany poziom dostępu do generowania tokenu osadzania

Nazwa	Typ	Opis
Create	string	Wskazuje, że wygenerowane token osadzania przyznaje uprawnienie do tworzenia. Ma zastosowanie tylko w przypadku generowania tokenu osadzania na potrzeby tworzenia raportu.
Edit	string	Wskazuje, że wygenerowany token osadzania przyznaje uprawnienia do wyświetlania i edytowania. Ma zastosowanie tylko w przypadku generowania tokenu osadzania raportu.
View	string	Wskazuje, że wygenerowane token osadzania przyznaje uprawnienie tylko do wyświetlania

Udostępnij za pośrednictwem

Embed Token - Dashboards GenerateTokenInGroup

Uprawnienia

Wymagany zakres

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

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

Definicje

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel

Dodatkowe zasoby