Step-by-Step Guide to Configure Power Pages Web API for Dataverse Integration

Introduction

This article will explain the required site settings and configurations needed to perform CRUD (Create, Read, Update, Delete) operations in Power Pages using the Web API. You'll learn how to enable the Web API through site settings, configure table permissions, and set up appropriate web roles to control access. At the end of this article, you'll be able to set up all the required site settings and permissions to easily perform add, view, update, and delete operations on Dataverse data using Power Pages Web API.

Prerequisites

• A Power Pages site connected to your Microsoft Dataverse environment.

• Permission to edit site settings in Power Pages.

• Access to the Dataverse tables you want to use.

Below are the steps to configure Power Pages Web API to perform CRUD operations on Dataverse data.

Step 1

Open the Portal Management App by clicking on the three dots (…) next to your Power Pages site in the Power Pages Maker portal, and then select Power Pages Management. This will open the management area where you can configure site settings, table permissions, and web roles needed for the Web API setup.

Step 2

Go to Site Settings in the left navigation panel, then click on New from the top menu bar. This allows you to create a new site setting that will help enable the Web API feature for your Power Pages site.

Step 3

Add the following four Site Settings one by one to enable and secure the Web API:

1. Name: WebApi/Enabled, Website: Select your page site, Source: Table, Value: true
   This setting turns on the Web API feature for your portal.

2. Name: WebApi/EntityPermissionsEnabled, Website: Select your page site, Source: Table, Value: true
   This setting enables Entity (Table) Permissions for the Web API.

3. Name: Webapi/<TableLogicalName>/enabled, Website: Select your page site, Source: Table, Value: True
   This setting allows the Web API to be enabled specifically for a particular Dataverse table. Replace <TableLogicalName> with the logical name of the table you want to access.

4. Name: Webapi/<TableLogicalName>/fields, Website: Select your page site, Source: Table, Value: *
   This setting defines which columns (fields) of a specific Dataverse table can be accessed through the Web API. Replace <TableLogicalName> with the logical name of your table.
   
   If you want to allow access to all columns, set the Value to *.
   If you want to restrict access to specific columns, enter the column logical names separated by commas (for example: fullname,emailaddress1,etc)

Step 4

Go to Table Permissions in the left navigation panel, then click on New to create a new table permission. This permission will define which Dataverse table your portal users can access through the Web API and what level of operations (Read, Create, Update, Delete) they are allowed to perform.

Step 5

Fill in the required details for the new table permission, such as Access Type and Privileges.

• Access Type: Choose how access will be granted (for example, Global, Contact, or Account).

• Privileges: Select the actions users are allowed to perform — Read, Create, Update, or Delete.

Step 6

Assign Web Roles to the table permission you created.

1. Go to Security → Table Permissions.

2. Open the table permission record you just created.

3. Under the Roles section, click Add Roles to assign appropriate web roles.

Common web roles include:

• Anonymous Users: Users who are not signed in. Used to control public or read-only content.

• Authenticated Users: Any user who signs in to the portal. Typically used for basic access to data.

• Administrators: Users with full access to manage content, data, and settings within the portal.

Conclusion

By following these steps, you've learned how to set up and configure the Power Pages Web API to connect with Dataverse. You enabled the required site settings, created table permissions, and assigned web roles to control access.