Embed Token - Datasets GenerateTokenInGroup
指定したワークスペースから、指定したデータセットに基づいて埋め込みトークンを生成します。
ヒント
埋め込みトークンを作成するには、最新の API トークンの生成を使用することをお勧めします。 トークンの生成では、複数の項目のトークンの作成など、追加の関数がサポートされます。
注
埋め込みトークンを使用して、Q&A をアプリケーション内に埋め込む できます。
権限
- 認証にサービス プリンシパルを使用する場合は、「サービス プリンシパルの を使用して Power BI コンテンツを埋め込む」と の考慮事項と制限事項を参照してください。
- この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedでのサービス プリンシパル プロファイルの
」を参照してください。
必要なスコープ
Dataset.ReadWrite.All または Dataset.Read.All
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/GenerateTokenURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
dataset
|
path | True |
string |
データセット ID |
|
group
|
path | True |
string (uuid) |
ワークスペース ID |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| accessLevel |
埋め込みトークン生成に必要なアクセス レベル |
|
| allowSaveAs |
boolean |
埋め込みレポートを新しいレポートとして保存できるかどうかを指定します。 既定値は |
| datasetId |
string |
レポートの作成に使用されるデータセット ID。 レポート作成用の埋め込みトークンを生成する場合にのみ適用されます。 |
| identities |
行レベルのセキュリティ規則に使用する ID の一覧 |
|
| lifetimeInMinutes |
integer |
トークンの最大有効期間 (生成時刻から開始) (分単位)。 トークンの有効期限を短縮するために使用できますが、それを拡張することはできません。 値は正の整数である必要があります。 ゼロ (0) は null に相当し、無視され、既定の有効期限になります。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
わかりました |
例
Example
要求のサンプル
POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GenerateToken{
"accessLevel": "View"
}応答のサンプル
{
"token": "H4sI....AAA=",
"tokenId": "49ae3742-54c0-4c29-af52-619ff93b5c80",
"expiration": "2018-07-29T17:58:19Z"
}定義
| 名前 | 説明 |
|---|---|
|
Effective |
ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。 |
|
Embed |
Power BI 埋め込みトークン |
|
Generate |
Power BI のトークン生成要求 |
|
Identity |
ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます |
|
Token |
埋め込みトークン生成に必要なアクセス レベル |
EffectiveIdentity
ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| auditableContext |
string |
EffectiveIdentity 監査可能なコンテキスト。 このパラメーターが指定され、空でない場合は、EffectiveIdentity の監査が有効になり、その値は監査レコードのユーザー名に設定されます。 それ以外の場合、EffectiveIdentity コンテキストは GenerateToken 監査レコードから省略されます。 |
| customData |
string |
行レベルのセキュリティ規則の適用に使用されるカスタム データ。 Azure Analysis Services モデルとクラウド モデルへのライブ接続でのみサポートされます。 |
| datasets |
string[] |
この ID が適用されるデータセットの配列 |
| identityBlob |
IDを指定する BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます。 |
|
| reports |
string[] |
この ID が適用されるレポートの配列。 ページ分割されたレポートでのみサポートされます。 |
| roles |
string[] |
RLS ルールを適用するトークン内の行レベル セキュリティ (RLS) ロールの配列。 ID には、最大 50 個のロールを含めることができます。 ロールには、 |
| username |
string |
行レベルのセキュリティ規則を適用するトークン内の有効なユーザー名。 オンプレミス モデルの場合、ユーザー名には、英数字、または次のいずれかの文字 |
EmbedToken
Power BI 埋め込みトークン
| 名前 | 型 | 説明 |
|---|---|---|
| expiration |
string (date-time) |
トークンの有効期限の日付と時刻 (UTC) |
| token |
string |
埋め込みトークン |
| tokenId |
string (uuid) |
一意のトークン ID。 監査ログを使用すると、トークン ID を使用して、トークンを使用する操作を生成操作と関連付けることができます。 |
GenerateTokenRequest
Power BI のトークン生成要求
| 名前 | 型 | 説明 |
|---|---|---|
| accessLevel |
埋め込みトークン生成に必要なアクセス レベル |
|
| allowSaveAs |
boolean |
埋め込みレポートを新しいレポートとして保存できるかどうかを指定します。 既定値は |
| datasetId |
string |
レポートの作成に使用されるデータセット ID。 レポート作成用の埋め込みトークンを生成する場合にのみ適用されます。 |
| identities |
行レベルのセキュリティ規則に使用する ID の一覧 |
|
| lifetimeInMinutes |
integer |
トークンの最大有効期間 (生成時刻から開始) (分単位)。 トークンの有効期限を短縮するために使用できますが、それを拡張することはできません。 値は正の整数である必要があります。 ゼロ (0) は null に相当し、無視され、既定の有効期限になります。 |
IdentityBlob
ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます
| 名前 | 型 | 説明 |
|---|---|---|
| value |
string |
Azure SQL の OAuth 2.0 アクセス トークン |
TokenAccessLevel
埋め込みトークン生成に必要なアクセス レベル
| 値 | 説明 |
|---|---|
| Create |
生成された埋め込みトークンによって作成アクセス許可が付与されることを示します。 レポート作成用の埋め込みトークンを生成する場合にのみ適用されます。 |
| Edit |
生成された埋め込みトークンによってビューと編集のアクセス許可が付与されることを示します。 レポート埋め込み用の埋め込みトークンを生成する場合にのみ適用されます。 |
| View |
生成された埋め込みトークンがビューのみのアクセス許可を付与することを示します |