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 パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID
groupId	path	True	string uuid	ワークスペース ID

要求本文

名前	型	説明
accessLevel	TokenAccessLevel	埋め込みトークン生成に必要なアクセスレベル
allowSaveAs	boolean	埋め込みレポートを新しいレポートとして保存できるかどうか。既定値は `false` です。レポート埋め込み用の埋め込みトークンを生成する場合にのみ適用されます。
datasetId	string	レポートの作成に使用されるデータセット ID。レポート作成用の埋め込みトークンを生成する場合にのみ適用されます。
identities	EffectiveIdentity[]	行レベルのセキュリティ規則に使用する ID の一覧
lifetimeInMinutes	integer	生成された時刻から始まる、トークンの最大有効期間 (分単位)。トークンの有効期限を短縮するために使用できますが、それを拡張することはできません。この値は、正の整数にする必要があります。ゼロ (0) は null に相当し、無視され、既定の有効期限になります。

応答

名前	型	説明
200 OK	EmbedToken	OK

例

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"
}

定義

名前	説明
EffectiveIdentity	ユーザー ID とロールを定義します。詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。
EmbedToken	Power BI 埋め込みトークン
GenerateTokenRequest	Power BI のトークン生成要求
IdentityBlob	ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます
TokenAccessLevel	埋め込みトークン生成に必要なアクセスレベル

EffectiveIdentity

ユーザー ID とロールを定義します。詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。

名前	型	説明
auditableContext	string	EffectiveIdentity 監査可能なコンテキスト。このパラメーターが指定され、空でない場合は、EffectiveIdentity の監査が有効になり、その値は監査レコードのユーザー名に設定されます。それ以外の場合は、GenerateToken 監査レコードから EffectiveIdentity コンテキストが省略されます。
customData	string	行レベルのセキュリティ規則を適用するために使用されるカスタムデータ。 Azure Analysis Services モデルとクラウドモデルへのライブ接続でのみサポートされます。
datasets	string[]	この ID が適用されるデータセットの配列
identityBlob	IdentityBlob	ID を指定する BLOB。 Azure SQLへの DirectQuery 接続を持つデータセットでのみサポートされます。
reports	string[]	この ID が適用されるレポートの配列。ページ分割されたレポートでのみサポートされます。
roles	string[]	RLS ルールを適用するトークン内の行レベルセキュリティ (RLS) ロールの配列。 ID には、最大 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[]	行レベルのセキュリティ規則に使用する ID の一覧
lifetimeInMinutes	integer	生成された時刻から始まる、トークンの最大有効期間 (分単位)。トークンの有効期限を短縮するために使用できますが、それを拡張することはできません。この値は、正の整数にする必要があります。ゼロ (0) は null に相当し、無視され、既定の有効期限になります。

IdentityBlob

ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます

名前	型	説明
value	string	Azure SQLの OAuth 2.0 アクセストークン

TokenAccessLevel

埋め込みトークン生成に必要なアクセスレベル

名前	型	説明
Create	string	生成された埋め込みトークンが作成アクセス許可を付与することを示します。レポート作成用の埋め込みトークンを生成する場合にのみ適用されます。
Edit	string	生成された埋め込みトークンによって、ビューと編集のアクセス許可が付与されることを示します。レポート埋め込み用の埋め込みトークンを生成する場合にのみ適用されます。
View	string	生成された埋め込みトークンがビューのみのアクセス許可を付与することを示します