共用方式為

Embed Token - Tiles GenerateTokenInGroup

  • 參考
服務:
Power BI REST APIs
API 版本:
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 參數

名稱 位於 必要 類型 Description
dashboardId
 path True

string (uuid)

儀錶板標識碼
groupId
 path True

string (uuid)

工作區標識碼
tileId
 path True

string (uuid)

磚標識碼

要求本文

名稱 類型 Description
accessLevel

TokenAccessLevel

內嵌令牌產生所需的存取層級
allowSaveAs

boolean

是否可以將內嵌報表儲存為新的報表。 預設值是 false。 只有在產生報表內嵌的內嵌令牌時才適用。
datasetId

string

用於建立報表的數據集標識碼。 只有在產生用於建立報表的內嵌令牌時，才適用。
identities

EffectiveIdentity[]

要用於數據列層級安全性規則的身分識別清單
lifetimeInMinutes

integer

令牌的存留期上限，以分鐘為單位，從產生令牌的時間開始。 可用來縮短令牌的到期時間，但不能加以擴充。 其值必須為正整數。 零 （0） 相當於 null，而且會被忽略，導致預設到期時間。

回應

名稱 類型 Description
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

範例要求

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
要求本文
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

範例回覆

狀態碼:
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

範例要求

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
要求本文
{
  "accessLevel": "View",
  "identities": [
    {
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ],
      "identityBlob": {
        "value": "eyJ0eX....AAA="
      }
    }
  ]
}

範例回覆

狀態碼:
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

範例要求

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
要求本文
{
  "accessLevel": "View",
  "identities": [
    {
      "username": "john@contoso.com",
      "customData": "john_contoso.com",
      "roles": [
        "sales"
      ],
      "datasets": [
        "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
      ]
    }
  ]
}

範例回覆

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

定義

名稱 Description
EffectiveIdentity

定義使用者身分識別和角色。 如需詳細資訊，請參閱使用Power BI Embedded 資料列層級安全性。
EmbedToken

Power BI 內嵌令牌
GenerateTokenRequest

Power BI 產生令牌要求
IdentityBlob

指定身分識別的 Blob。 僅支援具有 Azure SQL DirectQuery 連線的數據集
TokenAccessLevel

內嵌令牌產生所需的存取層級

EffectiveIdentity

Object

定義使用者身分識別和角色。 如需詳細資訊，請參閱使用Power BI Embedded 資料列層級安全性。

名稱 類型 Description
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

Object

Power BI 內嵌令牌

名稱 類型 Description
expiration

string (date-time)

令牌到期的日期和時間
token

string

內嵌令牌
tokenId

string (uuid)

唯一令牌標識碼。 透過稽核記錄，令牌標識碼可用來將使用令牌與產生作業的作業相互關聯。

GenerateTokenRequest

Object

Power BI 產生令牌要求

名稱 類型 Description
accessLevel

TokenAccessLevel

內嵌令牌產生所需的存取層級
allowSaveAs

boolean

是否可以將內嵌報表儲存為新的報表。 預設值是 false。 只有在產生報表內嵌的內嵌令牌時才適用。
datasetId

string

用於建立報表的數據集標識碼。 只有在產生用於建立報表的內嵌令牌時，才適用。
identities

EffectiveIdentity[]

要用於數據列層級安全性規則的身分識別清單
lifetimeInMinutes

integer

令牌的存留期上限，以分鐘為單位，從產生令牌的時間開始。 可用來縮短令牌的到期時間，但不能加以擴充。 其值必須為正整數。 零 （0） 相當於 null，而且會被忽略，導致預設到期時間。

IdentityBlob

Object

指定身分識別的 Blob。 僅支援具有 Azure SQL DirectQuery 連線的數據集

名稱 類型 Description
value

string

Azure SQL 的 OAuth 2.0 存取令牌

TokenAccessLevel

列舉型別

內嵌令牌產生所需的存取層級

值 Description
Create

表示產生的內嵌令牌會授與建立許可權。 只有在產生用於建立報表的內嵌令牌時，才適用。
Edit

表示產生的內嵌令牌會授與檢視和編輯許可權。 只有在產生報表內嵌的內嵌令牌時才適用。
View

表示產生的內嵌令牌會授與僅限檢視許可權