Dataverse Custom API Toolkit

Manage Microsoft Dataverse Custom APIs directly from VS Code.

The Dataverse Custom API Toolkit gives you a developer-friendly UI for working with Custom API metadata, request parameters and response properties without constantly switching back to the Dataverse Maker Portal. It is built on top of the @brunsforge/dataverse-custom-api CLI and brings environment management, export, validation, diff, sync planning and privilege checks into the VS Code sidebar.

Instead of editing Custom APIs field by field in make.powerapps.com, you can connect to an environment, export an API definition, review and edit it locally, compare it with Dataverse metadata, and sync changes back in a controlled way.

Why use this extension?

Edit Custom APIs in a proper developer UI

The main value of the extension is the Custom API Editor. It exposes the relevant Dataverse Custom API metadata in a structured VS Code editor view, including:

• Custom API unique name, name, display name and description
• binding type and bound entity logical name
• function/private/workflow SDK flags
• allowed custom processing step type
• plugin type and plugin assembly metadata
• request parameters
• response properties

This is especially useful when working with APIs that have several parameters or response properties. The editor gives you a clearer overview than the Maker Portal and keeps the definition close to your development workflow.

Edit request parameters Add or update request parameters with display name, description, type and optional flags.

Edit response properties Maintain response properties in the same UI-driven workflow.

Work locally, review safely, then sync

The toolkit exports Custom API metadata as local JSON. That makes changes easier to inspect, diff, version and review before they are applied to Dataverse.

Typical workflow:

1. Connect to a Dataverse environment
2. Select or export a Custom API
3. Edit the local definition in the UI
4. Compare local changes with Dataverse metadata
5. Build and review a sync plan
6. Save and sync the changes back to Dataverse

Keep environment and metadata handling transparent

The extension keeps the important operations visible in the DVC sidebar:

• which environment is active
• which Custom API is active
• whether an API exists only locally or also in Dataverse
• what will change before a sync
• whether the app user has the required privileges

Features

• Connect to multiple Dataverse environments
• Store, edit, switch and remove environment profiles
• List Custom APIs from the active Dataverse environment
• Filter Custom APIs by category and search by name
• Select an active Custom API
• Export Custom API definitions as local JSON
• Create new local Custom API definitions
• Edit Custom API metadata in a UI-driven editor
• Edit request parameters
• Edit response properties
• Open the underlying JSON definition when needed
• Compare local definitions against Dataverse metadata
• Check metadata consistency
• Build and review sync plans
• Save and sync Custom API changes back to Dataverse
• Validate app-user privileges required for Custom API management
• Use graceful fallback behavior when plugin type binding privileges are missing

DVC Sidebar Overview

The extension adds a dedicated DVC Activity Bar view to VS Code.

The sidebar is split into three main sections:

Sidebar Actions

Environments section

The Environments section shows all saved Dataverse connections. The active environment is marked in the tree.

Connect from Actions

Connect from Environments

Connect to a Dataverse environment

When connecting to an environment, the extension prompts for the required settings. Supported authentication modes come from the underlying Azure Identity-based CLI configuration, including device code, interactive browser and client secret based authentication.

The environment configuration can be edited later. This is useful when you want to rename a connection, change the environment URL or adjust authentication-related settings.

Custom API section

The Custom APIs section lists Custom APIs from the active Dataverse environment and local Custom API artifacts.

Visual indicators help distinguish remote APIs, local artifacts and the currently active API.

Export Custom APIs as JSON

Exporting creates a local JSON representation of the selected Custom API. The JSON file can be inspected, versioned or edited manually if needed.

Diff, metadata checks and sync plans

Before applying changes, the extension can compare the local definition with the current Dataverse metadata. This makes it easier to understand what changed and which operations are required.

Build diff

Diff details

Actions panel

The Actions section contains the most important commands for the active workflow.

App-user privileges

The service principal used to connect to Dataverse requires specific privileges. You can check the current status at any time using Validate App-User Privileges in the Actions panel. Results are written to the DVC output channel.

Required privileges

The first four privileges are covered by the System Customizer role. The last two are not included in any standard role and must be assigned through a custom security role.

Graceful fallback for missing prvAppendToPluginType

When a Custom API is created with a pluginTypeId but the app user lacks prvAppendToPluginType, Dataverse returns HTTP 403. The toolkit automatically retries the create operation without the PluginTypeId@odata.bind field so the API itself is still created successfully.

A warning is shown in the Sync panel and logged to the DVC output channel.

To resolve permanently, create a custom security role with:

• Entity: Plug-In-Typ / plugintype
• Privilege: AppendTo / prvAppendToPluginType
• Scope: Organisation

Assign this role to the app user in addition to System Customizer.

prvCreateSdkMessageProcessingStep — no fallback

This privilege is required to register plugin execution steps. There is currently no automatic fallback for this operation. A missing privilege will cause a hard failure when syncing Custom API definitions that include step registrations.

Requirements

• VS Code
• Node.js
• Access to a Dataverse environment
• Microsoft Entra app registration for authentication
• Sufficient Dataverse privileges for Custom API metadata

Getting started

1. Install the extension.
2. Open the DVC Activity Bar view.
3. Use Connect Environment to add a Dataverse environment.
4. Select the environment.
5. Export an existing Custom API or create a new local definition.
6. Open the Custom API Editor.
7. Edit metadata, request parameters and response properties.
8. Run Diff Current API or Check Metadata Consistency.
9. Use Save & Sync to Dataverse when you are ready to apply the changes.

Notes

Live sync operations may create, update or delete Dataverse Custom API metadata. Review diffs and sync plans before applying changes to production environments.

License

MIT

Author

Andreas Brunsmann
GitHub: https://github.com/brunsforge