Tutorial: Embed Power BI content using a sample embed for your organization application

Power BI embedded analytics allows you to embed Power BI content, such as reports, dashboards and tiles, into your application.

In this tutorial, you'll learn how to:

To use your application, your users will need to sign in to Power BI.

The embed for your organization solution is typically used by enterprises and large organizations, and is intended for internal users.

Code sample specifications

This tutorial includes instructions for configuring an embed for your organization sample application in one of the following frameworks:

• .NET Framework
• .NET Core
• React TypeScript

The code samples support the following browsers:

• Microsoft Edge
• Google Chrome
• Mozilla Firefox

Prerequisites

Before you start this tutorial, verify that you have both the following Power BI and code dependencies:

• Power BI dependencies

  • Your own Microsoft Entra tenant.

    • One of the following licenses:

      • Power BI Pro

      • Premium Per User (PPU)

    Note

    To move to production you'll need one of the following configurations:

    • All users with Pro licenses.
    • All users with PPU licenses.
    • A SKU that's equivalent or higher to a F64 SKU. This configuration allows all users to have free licenses.

• Code dependencies

  • .NET Core
  • .NET Framework
  • React TypeScript

  • .NET Core 3.1 SDK (or higher)

  • An integrated development environment (IDE). We recommend using one of the following IDEs:

    • Visual Studio

    • Visual Studio Code

Method

To create an embed for your organization sample app, follow these steps:

1. Register a Microsoft Entra application.

2. Create a Power BI workspace.

3. Create and publish a Power BI report.

4. Get the embedding parameter values.

5. Embed your content.

Step 1 - Register a Microsoft Entra application

Registering your application with Microsoft Entra ID allows you to establish an identity for your app.

To register your application with Microsoft Entra ID, follow the instructions in Register your application.

Step 2 - Create a Power BI workspace

Power BI keeps your reports, dashboards, and tiles in a workspace. To embed these items, you'll need to create them and upload them into a workspace.

To create a workspace, do the following:

1. Sign in to Power BI.

2. Select Workspaces.

3. Select Create a workspace.

4. Name your workspace and select Save.

Step 3 - Create and publish a Power BI report

Your next step is to create a report and upload it to your workspace. You can create your own report using Power BI Desktop, and then publish it to your workspace. Or, you can upload a sample report to your workspace.

To download a sample report and publish it to your workspace, follow these steps:

1. Open the GitHub Power BI Desktop samples folder.

2. Select Code and then select Download zip.

   

3. Extract the downloaded ZIP and navigate to the Samples Reports folder.

4. Select a report to embed, and publish it to your workspace.

Step 4 - Get the embedding parameter values

To embed your content, you'll need to obtain a few parameter values. The parameter values depend on the language of the sample application you want to use. The table below lists which parameter values are required for each sample.

Parameter	.NET Core	.NET Framework	React TypeScript
Client ID
Client secret
Workspace ID
Report ID

Client ID

To get the client ID GUID (also know as application ID), follow these steps:

1. Log into Microsoft Azure.

2. Search for App registrations and select the App registrations link.

3. Select the Microsoft Entra app you're using for embedding your Power BI content.

4. From the Overview section, copy the Application (client) ID GUID.

Client secret

To get the client secret, follow these steps:

1. Log into Microsoft Azure.

2. Search for App registrations and select the App registrations link.

3. Select the Microsoft Entra app you're using for embedding your Power BI content.

4. Under Manage, select Certificates & secrets.

5. Under Client secrets, select New client secret.

6. In the Add a client secret pop-up window, provide a description for your application secret, select when the application secret expires, and select Add.

7. From the Client secrets section, copy the string in the Value column of the newly created application secret. The client secret value is your client ID.

Workspace ID

To get the workspace ID GUID, follow these steps:

1. Sign in to Power BI service.

2. Open the report you want to embed.

3. Copy the GUID from the URL. The GUID is the number between /groups/ and /reports/.

   

Report ID

To get the report ID GUID, follow these steps:

1. Sign in to Power BI service.

2. Open the report you want to embed.

3. Copy the GUID from the URL. The GUID is the number between /reports/ and /ReportSection.

   

Step 5 - Embed your content

The Power BI embedded sample application allows you to create an embed for your organization Power BI app.

Follow these steps to modify the embed for your organization sample application, to embed your Power BI report.

1. Open the Power BI developer samples folder.

2. Select Code and then select Download zip.

   

3. Extract the downloaded ZIP and navigate to the PowerBI-Developer-Samples-master folder.

4. Open one of the following folders depending on the language you want your application to use:

   • .NET Core
   • .NET Framework
   • React-TS

   Note

   The embed for your organization sample applications only support the previously listed frameworks. The Java, Node JS and Python sample applications, only support the embed for your customers solution.

Develop your application

After configuring and running the embed for your customers sample application, you can start developing your own application.

Update user permissions

Users need permission to access the Power BI folder the report is in. When you grant a user permission to access a folder, the change usually takes effect only after the user logs in to the Power BI Portal. For the new permissions to take effect immediately, in the Embedded scenario, make an explicit call to the RefreshUser Permissions REST API at startup. This API call will refresh the permissions and avoid authorization failures for users with newly granted permissions.

Related content