Embed Token

Operations

Dashboards GenerateTokenInGroup

Generates an embed token to view the specified dashboard from the specified workspace.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

When using a service principal for authentication, refer to Embed Power BI content with service principal and Considerations and limitations.

Required scope

All of the following:

  • Dashboard.ReadWrite.All or Dashboard.Read.All
  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All
Datasets GenerateTokenInGroup

Generates an embed token based on the specified dataset from the specified workspace.

Note

An embed token can be used to embed Q&A within your application.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

When using a service principal for authentication, refer to Embed Power BI content with service principal and Considerations and limitations.

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

Generate Token

Generates an embed token for multiple reports, datasets, and target workspaces.

  • Reports and datasets don't have to be related.
  • You can bind a report to a dataset during embedding.
  • You can only create a report in workspaces specified by the targetWorkspaces parameter.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

Required scope

All of the following, unless a requirement doesn't apply:

  • Content.Create, required if a target workspace is specified in GenerateTokenRequestV2.
  • Report.ReadWrite.All or Report.Read.All, required if a report is specified in GenerateTokenRequestV2.
  • Report.ReadWrite.All, required if the allowEdit flag is specified for at least one report in GenerateTokenRequestV2.
  • Dataset.ReadWrite.All or Dataset.Read.All

Limitations

  • You can only create a report in workspaces specified by the targetWorkspaces parameter.
  • All reports and datasets must reside in a V2 workspace.
  • All target workspaces must be V2 workspaces.
  • Maximum 50 reports.
  • Maximum 50 datasets.
  • Maximum 50 target workspaces.
  • For Azure Analysis Services or Analysis Services on-premises live connection reports, generating an embed token with row-level security might not work for several minutes after a rebind.
Reports GenerateTokenForCreateInGroup

Generates an embed token to allow report creation in the specified workspace based on the specified dataset.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

When using a service principal for authentication, refer to Embed Power BI content with service principal and Considerations and limitations.

Required scope

All of the following:

  • Content.Create
  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All

Limitations

For Azure Analysis Services or Analysis Services on-premises live connection reports, generating an embed token with row-level security may not work for several minutes after a Rebind Report api call.

Reports GenerateTokenInGroup

Generates an embed token to view or edit the specified report from the specified workspace.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

When using a service principal for authentication, refer to Embed Power BI content with service principal and Considerations and limitations.

Required scope

All of the following, unless a requirement doesn't apply:

  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All
  • Content.Create, required if the allowSaveAs flag is specified in GenerateTokenRequest

Limitations

For Azure Analysis Services or Analysis Services on-premises live connection reports, generating an embed token with row-level security may not work for several minutes after a Rebind Report.

Tiles GenerateTokenInGroup

Generates an embed token to view the specified tile from the specified workspace.

Important

This API is only relevant to the embed for your customers scenario. To learn more about using this API, see Considerations when generating an embed token.

Permissions

When using a service principal for authentication, refer to Embed Power BI content with service principal and Considerations and limitations.

Required scope

All of the following:

  • Dashboard.ReadWrite.All or Dashboard.Read.All
  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All