Embed Token - Dashboards GenerateTokenInGroup

Servizio:: Power BI REST APIs

Versione API:: v1.0

Genera un token di incorporamento per visualizzare il dashboard specificato dall'area di lavoro specificata.

Importante

Questa chiamata API è rilevante solo per lo scenario di incorporamento per i clienti scenario. Per altre informazioni sull'uso di questa API, vedere Considerazioni per la generazione di un token di incorporamento.

Autorizzazioni

Quando si usa un'entità servizio per l'autenticazione, vedere Incorporare contenuto di Power BI con dell'entità servizio e considerazioni e limitazioni .
Questa chiamata API può essere chiamata da un profilo dell'entità servizio. Per altre informazioni, vedere: profili entità servizio in Power BI Embedded.

Ambito obbligatorio

Tutte le seguenti:

Dashboard.ReadWrite.All o Dashboard.Read.All
Report.ReadWrite.All o Report.Read.All
Dataset.ReadWrite.All o Dataset.Read.All

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
dashboardId	path	True	string (uuid)	The dashboard ID
groupId	path	True	string (uuid)	ID dell'area di lavoro

Corpo della richiesta

Nome	Tipo	Descrizione
accessLevel	TokenAccessLevel	Livello di accesso necessario per la generazione di token di incorporamento
allowSaveAs	boolean	Indica se un report incorporato può essere salvato come nuovo report. Il valore predefinito è `false`. Si applica solo quando si genera un token di incorporamento per l'incorporamento del report.
datasetId	string	ID del set di dati usato per la creazione del report. Si applica solo quando si genera un token di incorporamento per la creazione del report.
identities	EffectiveIdentity[]	Elenco di identità da usare per le regole di sicurezza a livello di riga
lifetimeInMinutes	integer	Durata massima del token in minuti, a partire dal momento in cui è stata generata. Può essere usato per abbreviare l'ora di scadenza di un token, ma non per estenderla. Il valore deve essere un numero intero positivo. Zero (0) equivale a null e verrà ignorato, con conseguente scadenza predefinita.

Risposte

Nome	Tipo	Descrizione
200 OK	EmbedToken	Va bene

Esempio

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

Esempio di richiesta

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

Corpo della richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Corpo della richiesta

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
EffectiveIdentity	Definisce l'identità utente e i ruoli. Per altre informazioni, vedere sicurezza a livello di riga con Power BI Embedded.
EmbedToken	Un token di incorporamento di Power BI
GenerateTokenRequest	Richiesta di generazione di token di Power BI
IdentityBlob	BLOB per specificare un'identità. Supportato solo per i set di dati con una connessione DirectQuery ad Azure SQL
TokenAccessLevel	Livello di accesso necessario per la generazione di token di incorporamento

EffectiveIdentity

Object

Definisce l'identità utente e i ruoli. Per altre informazioni, vedere sicurezza a livello di riga con Power BI Embedded.

Nome	Tipo	Descrizione
auditableContext	string	Contesto controllabile di EffectiveIdentity. Se questo parametro viene specificato e non è vuoto, abiliterà il controllo dell'EffectiveIdentity e il relativo valore verrà impostato sul nome utente nel record di controllo. In caso contrario, il contesto EffectiveIdentity verrà omesso dal record di controllo GenerateToken.
customData	string	dati personalizzati usati per applicare regole di sicurezza a livello di riga. Supportato solo per la connessione dinamica ai modelli di Azure Analysis Services e ai modelli cloud.
datasets	string[]	Matrice di set di dati per cui si applica questa identità
identityBlob	IdentityBlob	BLOB che specifica un'identità . Supportato solo per i set di dati con una connessione DirectQuery ad Azure SQL.
reports	string[]	Matrice di report per cui si applica questa identità. Supportato solo per i report impaginati.
roles	string[]	Matrice di ruoli di sicurezza a livello di riga all'interno di un token che applica regole di sicurezza a livello di riga. Un'identità può contenere fino a 50 ruoli. Un ruolo può contenere qualsiasi carattere tranne `,`e la sua lunghezza non deve superare i 50 caratteri.
username	string	Nome utente effettivo all'interno di un token che applica le regole di sicurezza a livello di riga. Per un modello locale, il nome utente può contenere caratteri alfanumerici o uno dei caratteri seguenti `.`, `-`, `_`, `!`, `#`, `^`, `~`, `\\`, `@`. Per i modelli cloud, il nome utente può contenere qualsiasi carattere ASCII. Per entrambi i modelli, la lunghezza del nome utente non deve superare i 256 caratteri e il nome utente non deve contenere spazi.

EmbedToken

Object

Un token di incorporamento di Power BI

Nome	Tipo	Descrizione
expiration	string (date-time)	Data e ora (UTC) della scadenza del token
token	string	Token di incorporamento
tokenId	string (uuid)	ID del token univoco. Tramite i log di controllo, l'ID token può essere usato per correlare le operazioni che usano il token con l'operazione di generazione.

GenerateTokenRequest

Object

Richiesta di generazione di token di Power BI

Nome	Tipo	Descrizione
accessLevel	TokenAccessLevel	Livello di accesso necessario per la generazione di token di incorporamento
allowSaveAs	boolean	Indica se un report incorporato può essere salvato come nuovo report. Il valore predefinito è `false`. Si applica solo quando si genera un token di incorporamento per l'incorporamento del report.
datasetId	string	ID del set di dati usato per la creazione del report. Si applica solo quando si genera un token di incorporamento per la creazione del report.
identities	EffectiveIdentity[]	Elenco di identità da usare per le regole di sicurezza a livello di riga
lifetimeInMinutes	integer	Durata massima del token in minuti, a partire dal momento in cui è stata generata. Può essere usato per abbreviare l'ora di scadenza di un token, ma non per estenderla. Il valore deve essere un numero intero positivo. Zero (0) equivale a null e verrà ignorato, con conseguente scadenza predefinita.

IdentityBlob

Object

BLOB per specificare un'identità. Supportato solo per i set di dati con una connessione DirectQuery ad Azure SQL

Nome	Tipo	Descrizione
value	string	Un token di accesso OAuth 2.0 per Azure SQL

TokenAccessLevel

Enumerazione

Livello di accesso necessario per la generazione di token di incorporamento

Valore	Descrizione
View	Indica che il token di incorporamento generato concede l'autorizzazione di sola visualizzazione
Edit	Indica che il token di incorporamento generato concede le autorizzazioni di visualizzazione e modifica. Si applica solo quando si genera un token di incorporamento per l'incorporamento del report.
Create	Indica che il token di incorporamento generato concede l'autorizzazione di creazione. Si applica solo quando si genera un token di incorporamento per la creazione del report.

Condividi tramite

Embed Token - Dashboards GenerateTokenInGroup

Autorizzazioni

Ambito obbligatorio

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

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

Esempio di richiesta

Risposta di esempio

Generate a dashboard embed token with multiple identities example

Esempio di richiesta

Risposta di esempio

Definizioni

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel