Embed Token - Datasets GenerateTokenInGroup

參考

Service:: Power BI REST APIs

API Version:: v1.0

根據指定工作區中的指定數據集產生內嵌令牌。

提示

若要建立內嵌令牌，建議您使用最新的 API 產生令牌。產生令牌支援其他函式，例如為多個專案建立令牌。

注意

內嵌令牌可用來在應用程式中內嵌 Q&A 。

重要

此 API 呼叫只與客戶案例的內嵌相關。若要深入瞭解如何使用此 API，請參閱產生內嵌令牌時的考慮。

權限

使用服務主體進行驗證時，請參閱使用服務主體內嵌Power BI內容和考慮和限制。
此 API 呼叫可由服務主體配置檔呼叫。如需詳細資訊，請參閱：Power BI Embedded 中的服務主體配置檔。

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	數據集標識碼
groupId	path	True	string uuid	工作區識別碼

要求本文

名稱	類型	Description
accessLevel	TokenAccessLevel	內嵌令牌產生所需的存取層級
allowSaveAs	boolean	是否可以將內嵌報表儲存為新的報表。預設值是 `false`。僅適用於產生報表內嵌的內嵌令牌時。
datasetId	string	用於建立報表的數據集標識碼。只有在產生用於建立報表的內嵌令牌時，才適用。
identities	EffectiveIdentity[]	要用於數據列層級安全性規則的身分識別清單
lifetimeInMinutes	integer	令牌的存留期上限，從產生令牌的時間開始。可用來縮短令牌的到期時間，但無法加以擴充。其值必須為正整數。零 (0) 相當於 null，而且將會忽略，導致預設到期時間。

回應

名稱	類型	Description
200 OK	EmbedToken	確定

範例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GenerateToken

Request Body

{
  "accessLevel": "View"
}

Sample Response

Status code:: 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。僅支援具有 DirectQuery 連線至 Azure SQL 的數據集
TokenAccessLevel	內嵌令牌產生所需的存取層級

EffectiveIdentity

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

名稱	類型	Description
auditableContext	string	EffectiveIdentity 可稽核的內容。如果提供此參數且不是空的，則會啟用 EffectiveIdentity 的稽核，而且其值將會設定為稽核記錄中的用戶名稱。否則，EffectiveIdentity 內容將會從 GenerateToken 稽核記錄中省略。
customData	string	用來套用數據列層級安全性規則的自定義數據。僅支援與 Azure Analysis Services 模型和雲端模型的即時連線。
datasets	string[]	套用此身分識別的數據集陣列
identityBlob	IdentityBlob	指定身分識別的 Blob。僅支援具有 DirectQuery 連線至 Azure SQL 的數據集。
reports	string[]	套用此身分識別的報表數位。僅支援編頁報表。
roles	string[]	套用 RLS 規則的令牌內，數據列層級安全性 (RLS) 角色的陣列。身分識別最多可以包含50個角色。角色可以包含除了以外的 `,`任何字元，而且其長度不能超過 50 個字元。
username	string	套用數據列層級安全性規則之令牌內的有效用戶名稱。針對內部部署模型，使用者名稱可以包含英數位元或下列任何字元`.`、`-`、`#^_!`、、 `\\@~` 針對雲端模型，用戶名稱可以包含任何 ASCII 字元。針對任一模型，用戶名稱長度不能超過 256 個字元，而且使用者名稱不應包含空格。

EmbedToken

Power BI 內嵌令牌

名稱	類型	Description
expiration	string	令牌到期的日期和時間 (UTC)
token	string	內嵌令牌
tokenId	string	唯一的令牌標識碼。透過稽核記錄，令牌標識碼可用來將使用令牌與產生作業的作業相互關聯。

GenerateTokenRequest

Power BI 產生令牌要求

名稱	類型	Description
accessLevel	TokenAccessLevel	內嵌令牌產生所需的存取層級
allowSaveAs	boolean	是否可以將內嵌報表儲存為新的報表。預設值是 `false`。僅適用於產生報表內嵌的內嵌令牌時。
datasetId	string	用於建立報表的數據集標識碼。只有在產生用於建立報表的內嵌令牌時，才適用。
identities	EffectiveIdentity[]	要用於數據列層級安全性規則的身分識別清單
lifetimeInMinutes	integer	令牌的存留期上限，從產生令牌的時間開始。可用來縮短令牌的到期時間，但無法加以擴充。其值必須為正整數。零 (0) 相當於 null，而且將會忽略，導致預設到期時間。

IdentityBlob

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

名稱	類型	Description
value	string	適用於 Azure SQL的 OAuth 2.0 存取令牌

TokenAccessLevel

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

名稱	類型	Description
Create	string	表示產生的內嵌令牌會授與建立許可權。只有在產生用於建立報表的內嵌令牌時，才適用。
Edit	string	指出產生的內嵌令牌授與檢視和編輯許可權。僅適用於產生報表內嵌的內嵌令牌時。
View	string	指出產生的內嵌令牌授與僅限檢視許可權