Embed Token - Tiles GenerateTokenInGroup

  • 参考
Service:
Power BI REST APIs
API Version:
v1.0

生成嵌入令牌，用于查看指定工作区中的指定磁贴。

重要

此 API 调用仅与 为客户嵌入 方案相关。 若要了解有关使用此 API 的详细信息，请参阅 生成嵌入令牌时的注意事项。

权限

所需范围

以下所有项：

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

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

URI 参数

名称 在 必需 类型 说明
dashboardId
 path True

string

uuid

仪表板 ID
groupId
 path True

string

uuid

工作区 ID
tileId
 path True

string

uuid

磁贴 ID

请求正文

名称 类型 说明
accessLevel

TokenAccessLevel

嵌入令牌生成所需的访问级别
allowSaveAs

boolean

嵌入的报表是否可以另存为新报表。 默认值为 false。 仅当生成用于报表嵌入的嵌入令牌时适用。
datasetId

string

用于创建报表的数据集 ID。 仅在生成用于创建报表的嵌入令牌时适用。
identities

EffectiveIdentity[]

用于行级别安全规则的标识列表
lifetimeInMinutes

integer

令牌的最长生存期（以分钟为单位），从生成时间开始计算。 可用于缩短令牌的过期时间，但不能用于延长令牌的过期时间。 该值必须是正整数。 零 (0) 等效于 null，将被忽略，从而导致默认过期时间。

响应

名称 类型 说明
200 OK

EmbedToken

确定

示例

Generate a tile embed token using an effective identity example
Generate a tile embed token using an effective identity with an identity blob example
Generate a tile embed token using an effective identity with custom data for Azure Analysis Services example

Generate a tile embed token using an effective identity example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/GenerateToken
Request Body
{
  "accessLevel": "View",
  "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"
}

Generate a tile 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/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/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 tile embed token using an effective identity with custom data for Azure Analysis Services example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af/tiles/312fbfe9-2eda-44e0-9ed0-ab5dc571bb4b/GenerateToken
Request Body
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "customData": "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"
}

定义

名称 说明
EffectiveIdentity

定义用户标识和角色。 有关详细信息，请参阅使用 Power BI Embedded 的行级别安全性。
EmbedToken

Power BI 嵌入令牌
GenerateTokenRequest

Power BI 生成令牌请求
IdentityBlob

用于指定标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集
TokenAccessLevel

嵌入令牌生成所需的访问级别

EffectiveIdentity

定义用户标识和角色。 有关详细信息，请参阅使用 Power BI Embedded 的行级别安全性。

名称 类型 说明
auditableContext

string

EffectiveIdentity 可审核上下文。 如果此参数已提供且不为空，它将启用 EffectiveIdentity 的审核，并且其值将设置为审核记录中的用户名。 否则，GenerateToken 审核记录中将省略 EffectiveIdentity 上下文。
customData

string

用于应用行级别安全规则的自定义数据。 仅支持与Azure Analysis Services模型和云模型的实时连接。
datasets

string[]

应用此标识的数据集数组
identityBlob

IdentityBlob

一个指定 标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集。
reports

string[]

应用此标识的报表数组。 仅分页报表支持。
roles

string[]

行级安全 (RLS) 应用 RLS 规则的令牌中的角色数组。 一个标识最多可以包含 50 个角色。 角色可以包含除 之外 ,的任何字符，其长度不得超过 50 个字符。
username

string

应用行级安全规则的令牌中的有效用户名。 对于本地模型，用户名可以包含字母数字或以下任意字符 .、、-、_、!^#、、~、 。 @\\ 对于云模型，用户名可以包含任何 ASCII 字符。 对于任一模型，用户名长度不得超过 256 个字符，并且用户名不应包含空格。

EmbedToken

Power BI 嵌入令牌

名称 类型 说明
expiration

string

令牌过期 (UTC) 日期和时间
token

string

嵌入令牌
tokenId

string

唯一令牌 ID。 通过审核日志，令牌 ID 可用于将使用该令牌的操作与生成操作相关联。

GenerateTokenRequest

Power BI 生成令牌请求

名称 类型 说明
accessLevel

TokenAccessLevel

嵌入令牌生成所需的访问级别
allowSaveAs

boolean

嵌入的报表是否可以另存为新报表。 默认值为 false。 仅当生成用于报表嵌入的嵌入令牌时适用。
datasetId

string

用于创建报表的数据集 ID。 仅在生成用于创建报表的嵌入令牌时适用。
identities

EffectiveIdentity[]

用于行级别安全规则的标识列表
lifetimeInMinutes

integer

令牌的最长生存期（以分钟为单位），从生成时间开始计算。 可用于缩短令牌的过期时间，但不能用于延长令牌的过期时间。 该值必须是正整数。 零 (0) 等效于 null，将被忽略，从而导致默认过期时间。

IdentityBlob

用于指定标识的 Blob。 仅支持与 Azure SQL 建立 DirectQuery 连接的数据集

名称 类型 说明
value

string

用于Azure SQL的 OAuth 2.0 访问令牌

TokenAccessLevel

嵌入令牌生成所需的访问级别

名称 类型 说明
Create

string

指示生成的嵌入令牌授予创建权限。 仅在生成用于创建报表的嵌入令牌时适用。
Edit

string

指示生成的嵌入令牌授予查看和编辑权限。 仅当生成用于报表嵌入的嵌入令牌时适用。
View

string

指示生成的嵌入令牌授予仅查看权限