Condividi tramite


Embed Token - Dashboards GenerateTokenInGroup

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

Importante

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

Autorizzazioni

Ambito obbligatorio

Tutte le operazioni 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 area di lavoro

Corpo della richiesta

Nome Tipo Descrizione
accessLevel

TokenAccessLevel

Livello di accesso necessario per la generazione di token di incorporamento

allowSaveAs

boolean

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 il report.

datasetId

string

ID del set di dati usato per la creazione di report. Si applica solo quando si genera un token di incorporamento per la creazione di report.

identities

EffectiveIdentity[]

Elenco delle 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 ridurre 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, causando la scadenza predefinita.

Risposte

Nome Tipo Descrizione
200 OK

EmbedToken

OK

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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/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 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
{
  "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

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

Token di incorporamento di Power BI

GenerateTokenRequest

Richiesta di token generati da Power BI

IdentityBlob

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

TokenAccessLevel

Livello di accesso necessario per la generazione di token di incorporamento

EffectiveIdentity

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 fornito e non è vuoto, abiliterà il controllo dell'effettività 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 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 a 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 (RLS) 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 relativa lunghezza non deve superare 50 caratteri.

username

string

Nome utente effettivo all'interno di un token che applica regole di sicurezza a livello di riga. Per un modello locale, il nome utente può contenere alfanumerici o uno dei seguenti caratteri ., #-!@_^~\\. . 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

Token di incorporamento di Power BI

Nome Tipo Descrizione
expiration

string

Data e ora (UTC) della scadenza del token

token

string

Token di incorporamento

tokenId

string

ID 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

Richiesta di token generati da Power BI

Nome Tipo Descrizione
accessLevel

TokenAccessLevel

Livello di accesso necessario per la generazione di token di incorporamento

allowSaveAs

boolean

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 il report.

datasetId

string

ID del set di dati usato per la creazione di report. Si applica solo quando si genera un token di incorporamento per la creazione di report.

identities

EffectiveIdentity[]

Elenco delle 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 ridurre 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, causando la scadenza predefinita.

IdentityBlob

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

Nome Tipo Descrizione
value

string

Token di accesso OAuth 2.0 per Azure SQL

TokenAccessLevel

Livello di accesso necessario per la generazione di token di incorporamento

Nome Tipo Descrizione
Create

string

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 di report.

Edit

string

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 il report.

View

string

Indica che il token di incorporamento generato concede l'autorizzazione di sola visualizzazione