Extension Permissions in Overview Pane

Introduction

This how-to describes how the permission system works for web extensions in Studio Pro. Permissions allow extensions to request access to sensitive APIs or data that require explicit user consent.

How Permissions Work

Web extensions can request permissions to access sensitive functionality. The permission system follows these principles:

• Opt-in by default — Extensions cannot access protected APIs unless you request persmission and the extension user grants it
• User control — You decide which permissions to grant through the Extensions Overview pane in Studio Pro
• Per-project settings — Permission grants are stored per project, so a user’s approval for an extension applies only within that app. This gives them the flexibility to grant a permission in one project and choose different settings for the same extension in another.

Requesting Permissions

To request a permission, declare it in your extension's package.json file under the mendix.permissions object:

{
  "mendixComponent": {
    "entryPoints": {
      "main": "main.js",
      "ui": {
        "tab": "tab.js"
      }
    },
    "permissions": {
      "runtime-configuration-private": true
    }
  }
}

Setting a permission to true indicates that your extension requests this permission. The user must grant it before your extension can use the protected functionality. Default: False

Granting Permissions (User Flow)

When a user installs an extension that requests permissions, they can manage those permissions through the Extensions Overview pane. Follow the steps below:

1. Open Studio Pro and load an app with the extension installed.
2. Go to View > Extensions Overview to open the Extensions Overview pane.
3. Find the extension in the list. Under the extension details, the Permissions section displays the requested permissions.
4. Check or uncheck the checkbox next to each permission to grant or revoke access.

Available Permissions

The following permissions are available for web extensions:

Extensibility Feedback

If you would like to provide additional feedback, you can complete a small survey.

Any feedback is appreciated.