Partager via

Embed Token - Dashboards GenerateTokenInGroup

Service:
Power BI REST APIs
Version d'API:
v1.0

Génère un jeton incorporé pour afficher le tableau de bord spécifié à partir de l’espace de travail spécifié.

Important

Cet appel d’API s’applique uniquement à l’incorporation pour vos clients scénario. Pour en savoir plus sur l’utilisation de cette API, consultez Considérations relatives à la génération d’un jeton incorporé.

Autorisations

Étendue requise

Toutes les opérations suivantes :

  • Dashboard.ReadWrite.All ou Dashboard.Read.All
  • Report.ReadWrite.All ou Report.Read.All
  • Dataset.ReadWrite.All ou Dataset.Read.All 

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

Paramètres URI

Nom Dans Obligatoire Type Description
dashboardId
 path True

string (uuid)

ID du tableau de bord
groupId
 path True

string (uuid)

Identifiant de l’espace de travail

Corps de la demande

Nom Type Description
accessLevel

TokenAccessLevel

Niveau d’accès requis pour la génération de jetons incorporés
allowSaveAs

boolean

Indique si un rapport incorporé peut être enregistré en tant que nouveau rapport. La valeur par défaut est false. S’applique uniquement lorsque vous générez un jeton incorporé pour l’incorporation de rapports.
datasetId

string

ID de jeu de données utilisé pour la création de rapports. S’applique uniquement lorsque vous générez un jeton incorporé pour la création de rapports.
identities

EffectiveIdentity[]

Liste des identités à utiliser pour les règles de sécurité au niveau des lignes
lifetimeInMinutes

integer

Durée de vie maximale du jeton en minutes, à partir du moment où il a été généré. Peut être utilisé pour raccourcir le délai d’expiration d’un jeton, mais pas pour l’étendre. La valeur doit être un entier positif. Zéro (0) équivaut à null et est ignoré, ce qui entraîne l’expiration par défaut.

Réponses

Nom Type Description
200 OK

EmbedToken

D’ACCORD

Exemples

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

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/GenerateToken
Corps de la demande
{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
EffectiveIdentity

Définit l’identité et les rôles de l’utilisateur. Pour plus d’informations, consultez sécurité au niveau des lignes avec Power BI Embedded.
EmbedToken

Un jeton d’incorporation Power BI
GenerateTokenRequest

Demande de jeton de génération power BI
IdentityBlob

Objet blob pour spécifier une identité. Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL
TokenAccessLevel

Niveau d’accès requis pour la génération de jetons incorporés

EffectiveIdentity

Object

Définit l’identité et les rôles de l’utilisateur. Pour plus d’informations, consultez sécurité au niveau des lignes avec Power BI Embedded.

Nom Type Description
auditableContext

string

Contexte auditable EffectiveIdentity. Si ce paramètre est fourni et n’est pas vide, il active l’audit de l’EffectiveIdentity et sa valeur est définie sur le nom d’utilisateur dans l’enregistrement d’audit. Sinon, le contexte EffectiveIdentity est omis à partir de l’enregistrement d’audit GenerateToken.
customData

string

données personnalisées utilisées pour appliquer des règles de sécurité au niveau des lignes. Prise en charge pour la connexion dynamique aux modèles Azure Analysis Services et aux modèles cloud uniquement.
datasets

string[]

Tableau de jeux de données pour lesquels cette identité s’applique
identityBlob

IdentityBlob

Objet blob qui spécifie une identité . Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL.
reports

string[]

Tableau de rapports pour lesquels cette identité s’applique. Uniquement pris en charge pour les rapports paginés.
roles

string[]

Tableau de rôles de sécurité au niveau des lignes (RLS) au sein d’un jeton qui applique des règles de sécurité au niveau des lignes. Une identité peut contenir jusqu’à 50 rôles. Un rôle peut contenir n’importe quel caractère, sauf ,, et sa longueur ne doit pas dépasser 50 caractères.
username

string

Nom d’utilisateur effectif dans un jeton qui applique des règles de sécurité au niveau des lignes. Pour un modèle local, le nom d’utilisateur peut contenir des caractères alphanumériques ou l’un des caractères suivants ., -, _, !, #, ^, ~, \\, @. Pour les modèles cloud, le nom d’utilisateur peut contenir n’importe quel caractère ASCII. Pour l’un ou l’autre modèle, la longueur du nom d’utilisateur ne doit pas dépasser 256 caractères et le nom d’utilisateur ne doit pas contenir d’espaces.

EmbedToken

Object

Un jeton d’incorporation Power BI

Nom Type Description
expiration

string (date-time)

Date et heure (UTC) de l’expiration du jeton
token

string

Jeton incorporé
tokenId

string (uuid)

ID de jeton unique. Grâce aux journaux d’audit, l’ID de jeton peut être utilisé pour mettre en corrélation les opérations qui utilisent le jeton avec l’opération de génération.

GenerateTokenRequest

Object

Demande de jeton de génération power BI

Nom Type Description
accessLevel

TokenAccessLevel

Niveau d’accès requis pour la génération de jetons incorporés
allowSaveAs

boolean

Indique si un rapport incorporé peut être enregistré en tant que nouveau rapport. La valeur par défaut est false. S’applique uniquement lorsque vous générez un jeton incorporé pour l’incorporation de rapports.
datasetId

string

ID de jeu de données utilisé pour la création de rapports. S’applique uniquement lorsque vous générez un jeton incorporé pour la création de rapports.
identities

EffectiveIdentity[]

Liste des identités à utiliser pour les règles de sécurité au niveau des lignes
lifetimeInMinutes

integer

Durée de vie maximale du jeton en minutes, à partir du moment où il a été généré. Peut être utilisé pour raccourcir le délai d’expiration d’un jeton, mais pas pour l’étendre. La valeur doit être un entier positif. Zéro (0) équivaut à null et est ignoré, ce qui entraîne l’expiration par défaut.

IdentityBlob

Object

Objet blob pour spécifier une identité. Uniquement pris en charge pour les jeux de données avec une connexion DirectQuery à Azure SQL

Nom Type Description
value

string

Jeton d’accès OAuth 2.0 pour Azure SQL

TokenAccessLevel

Énumération

Niveau d’accès requis pour la génération de jetons incorporés

Valeur Description
View

Indique que le jeton incorporé généré accorde l’autorisation d’affichage uniquement
Edit

Indique que le jeton incorporé généré accorde des autorisations d’affichage et de modification. S’applique uniquement lorsque vous générez un jeton incorporé pour l’incorporation de rapports.
Create

Indique que le jeton incorporé généré accorde l’autorisation de création. S’applique uniquement lorsque vous générez un jeton incorporé pour la création de rapports.