Partager via

Embed Token - Reports GenerateTokenForCreateInGroup

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Génère un jeton incorporé pour autoriser la création de rapports dans l’espace de travail spécifié en fonction du jeu de données spécifié.

Conseil

Pour créer des jetons incorporés, il est recommandé d’utiliser la dernière API, Générer un jeton. Générer un jeton prend en charge des fonctions supplémentaires, telles que la création d’un jeton pour plusieurs éléments.

Important

Cet appel d’API s’applique uniquement au scénario d’incorporation pour vos clients . 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 :

  • Content.Create
  • Report.ReadWrite.All ou Report.Read.All
  • Dataset.ReadWrite.All ou Dataset.Read.All

Limites

Pour Azure Analysis Services ou des rapports de connexion dynamique locale Analysis Services, la génération d’un jeton incorporé avec la sécurité au niveau des lignes peut ne pas fonctionner pendant plusieurs minutes après un appel d’API De rapport rebiné. 

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

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
 path True

string

uuid

L’ID 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 rapport.
datasetId

string

ID de jeu de données utilisé pour la création de rapport. S’applique uniquement lorsque vous générez un jeton incorporé pour la création d’un rapport.
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. Cette valeur doit être un entier positif. Zéro (0) équivaut à null et sera ignoré, ce qui entraîne le délai d’expiration par défaut.

Réponses

Nom Type Description
200 OK

EmbedToken

Ok

Exemples

Generate an embed token for report creation based on a specified dataset example
Generate an embed token for report creation based on a specified dataset example. The embed token uses an effective identity.

Generate an embed token for report creation based on a specified dataset example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/GenerateToken
Request Body
{
  "accessLevel": "Create",
  "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
}

Sample Response

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

Generate an embed token for report creation based on a specified dataset example. The embed token uses an effective identity.

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/GenerateToken
Request Body
{
  "accessLevel": "Create",
  "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

Sample Response

Status code:
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 incorporé Power BI
GenerateTokenRequest

Power BI Generate Token Request
IdentityBlob

Objet blob permettant de spécifier une identité. Pris en charge uniquement 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

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 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. Pris 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 auxquels cette identité s’applique
identityBlob

IdentityBlob

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

string[]

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

string[]

Tableau de rôles de sécurité au niveau des lignes (SNL) dans 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 à l’exception ,de , 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

Un jeton incorporé Power BI

Nom Type Description
expiration

string

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

string

Jeton incorporé
tokenId

string

ID de jeton unique. Par le biais des 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

Power BI Generate Token Request

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 rapport.
datasetId

string

ID de jeu de données utilisé pour la création de rapport. S’applique uniquement lorsque vous générez un jeton incorporé pour la création d’un rapport.
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. Cette valeur doit être un entier positif. Zéro (0) équivaut à null et sera ignoré, ce qui entraîne le délai d’expiration par défaut.

IdentityBlob

Objet blob permettant de spécifier une identité. Pris en charge uniquement 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

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

Nom Type Description
Create

string

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

string

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 rapport.
View

string

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