Embed Token

Operations

Dashboards GenerateTokenInGroup

Generates an embed token to view the specified dashboard from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.

Required scope: (all of the below)

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

To set the permissions scope, see Register an app.

Datasets GenerateTokenInGroup

Generates an embed token to Embed Q&A based on the specified dataset from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.

Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.

Generate Token

Generates an embed token for multiple reports, datasets and target workspaces. Reports and datasets do not have to be related. The binding of a report to a dataset can be done during embedding. Target workspaces are workspaces where creation of reports is allowed.
This API is relevant only to 'App owns data' embed scenario.

Required scope:

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

To set the permissions scope, see Register an app.

Restrictions

  • All the reports and datasets must reside in workspace V2. All the target workpaces must be workspace V2.
  • Maximum number of reports, datasets and target workspaces is 50 each.
  • Generating Embed Token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.

  • Reports GenerateTokenForCreateInGroup

    Generates an embed token to allow report creation on the specified workspace based on the specified dataset.
    This API is relevant only to 'App owns data' embed scenario.

    Required scope: (all of the below)

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

    To set the permissions scope, see Register an app.

    Restrictions

    Generating Embed Token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.

    Reports GenerateTokenInGroup

    Generates an embed token to view or edit the specified report from the specified workspace.
    This API is relevant only to 'App owns data' embed scenario.

    Required scope: (all of the below)

    • Report.ReadWrite.All or Report.Read.All
    • Dataset.ReadWrite.All or Dataset.Read.All
    • Content.Create - required only if allowSaveAs specified in GenerateTokenRequest

    To set the permissions scope, see Register an app.

    Restrictions

    Generating Embed Token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.

    Tiles GenerateTokenInGroup

    Generates an embed token to view the specified tile from the specified workspace.
    This API is relevant only to 'App owns data' embed scenario.

    Required scope: (all of the below)

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

    To set the permissions scope, see Register an app.