Embed Token - Tiles GenerateTokenInGroup

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

Создает токен внедрения для просмотра указанной плитки из указанной рабочей области.

Важно!

Этот вызов API относится только к сценарию внедрения для клиентов . Дополнительные сведения об использовании этого API см. в статье Рекомендации по созданию токена внедрения.

Разрешения

При использовании субъекта-службы для проверки подлинности ознакомьтесь с разделами Внедрение содержимого Power BI с помощью субъекта-службы и Рекомендации и ограничения.
Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в статье Профили субъектов-служб в Power BI Embedded.

Требуемая область

Все следующее:

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	Идентификатор панели мониторинга
groupId	path	True	string uuid	идентификатор рабочей области;
tileId	path	True	string uuid	Идентификатор плитки

Текст запроса

Имя	Тип	Описание
accessLevel	TokenAccessLevel	Необходимый уровень доступа для создания токена внедрения
allowSaveAs	boolean	Можно ли сохранить внедренный отчет в качестве нового отчета. Значение по умолчанию — `false`. Применяется только при создании токена внедрения для внедрения отчета.
datasetId	string	Идентификатор набора данных, используемый для создания отчета. Применяется только при создании токена внедрения для создания отчета.
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 Generate Token Request
IdentityBlob	Большой двоичный объект для указания удостоверения. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL
TokenAccessLevel	Необходимый уровень доступа для создания токена внедрения

EffectiveIdentity

Определяет удостоверение пользователя и роли. Дополнительные сведения см. в статье Безопасность на уровне строк с помощью Power BI Embedded.

Имя	Тип	Описание
auditableContext	string	Контекст, доступный для аудита EffectiveIdentity. Если этот параметр указан и не пуст, он включает аудит EffectiveIdentity и для него будет задано имя пользователя в записи аудита. В противном случае контекст EffectiveIdentity будет опущен в записи аудита GenerateToken.
customData	string	Пользовательские данные , используемые для применения правил безопасности на уровне строк. Поддерживается только для динамического подключения к Azure Analysis Services моделям и облачным моделям.
datasets	string[]	Массив наборов данных, к которым применяется это удостоверение.
identityBlob	IdentityBlob	Большой двоичный объект, указывающий удостоверение. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL.
reports	string[]	Массив отчетов, к которым применяется это удостоверение. Поддерживается только для отчетов с разбивкой на страницы.
roles	string[]	Массив ролей безопасности на уровне строк (RLS) в маркере, который применяет правила RLS. Удостоверение может содержать до 50 ролей. Роль может содержать любой символ, кроме `,`, и ее длина не должна превышать 50 символов.
username	string	Действующее имя пользователя в маркере, который применяет правила безопасности на уровне строк. Для локальной модели имя пользователя может содержать буквенно-цифровые или любой из следующих символов `.`, , `-`, `_`, `#^!`, `~`, `\\`, , . `@` Для облачных моделей имя пользователя может содержать любой символ ASCII. Для любой модели длина имени пользователя не должна превышать 256 символов, а имя пользователя не должно содержать пробелов.

EmbedToken

Токен внедрения Power BI

Имя	Тип	Описание
expiration	string	Дата и время окончания срока действия маркера (UTC)
token	string	Токен внедрения
tokenId	string	Уникальный идентификатор маркера. С помощью журналов аудита идентификатор маркера можно использовать для сопоставления операций, использующих маркер, с операцией создания.

GenerateTokenRequest

Power BI Generate Token Request

Имя	Тип	Описание
accessLevel	TokenAccessLevel	Необходимый уровень доступа для создания токена внедрения
allowSaveAs	boolean	Можно ли сохранить внедренный отчет в качестве нового отчета. Значение по умолчанию — `false`. Применяется только при создании токена внедрения для внедрения отчета.
datasetId	string	Идентификатор набора данных, используемый для создания отчета. Применяется только при создании токена внедрения для создания отчета.
identities	EffectiveIdentity[]	Список удостоверений, используемых для правил безопасности на уровне строк
lifetimeInMinutes	integer	Максимальное время существования маркера в минутах, начиная с момента его создания. Можно использовать для сокращения срока действия маркера, но не для его продления. Значение должно быть положительным целым числом. Ноль (0) эквивалентен значению NULL и игнорируется, что приводит к истечению срока действия по умолчанию.

IdentityBlob

Большой двоичный объект для указания удостоверения. Поддерживается только для наборов данных с подключением DirectQuery к Azure SQL

Имя	Тип	Описание
value	string	Маркер доступа OAuth 2.0 для Azure SQL

TokenAccessLevel

Необходимый уровень доступа для создания токена внедрения

Имя	Тип	Описание
Create	string	Указывает, что созданный токен внедрения предоставляет разрешение на создание. Применяется только при создании токена внедрения для создания отчета.
Edit	string	Указывает, что созданный токен внедрения предоставляет разрешения на просмотр и изменение. Применяется только при создании токена внедрения для внедрения отчета.
View	string	Указывает, что созданный токен внедрения предоставляет разрешение только для просмотра.

Embed Token - Tiles GenerateTokenInGroup

Разрешения

Требуемая область

Параметры URI

Текст запроса

Ответы

Примеры

Generate a tile embed token using an effective identity example

Sample Request

Sample Response

Generate a tile embed token using an effective identity with an identity blob example

Sample Request

Sample Response

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

Sample Request

Sample Response

Определения

EffectiveIdentity

EmbedToken

GenerateTokenRequest

IdentityBlob

TokenAccessLevel

Дополнительные ресурсы