You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
show: true # Whether to display a shortcut in the sidebar
30
-
label: "Configuration"# Text for the menu item
31
-
icon: "tune"# Material icon name
30
+
label: "Configuration"# Text for the menu item
31
+
icon: "tune"# Material icon name (see notes below)
32
32
order: 1# Ordering (lower = higher)
33
33
```
34
34
35
35
Notes
36
36
37
-
* plugin.embeddedView: boolean. true → FE renders embedded UI.
38
-
* plugin.sidebarItem: optional object configuring the Environment’s left sidebar item.
37
+
* `plugin.embeddedView`: boolean. true → FE renders embedded UI.
38
+
* `plugin.sidebarItem`: optional object configuring the Environment’s left sidebar item.
39
+
* `plugin.sidebarItem.icon`: must be a [Google Material icon](https://fonts.google.com/icons). Use the **internal icon code**, typically written in **lowercase** (e.g. `tune`, `settings`, `play_arrow`).
39
40
40
41
## Embedded view URL
41
42
@@ -46,10 +47,15 @@ Population rules:
46
47
* Managed service → Derived from Managed Services conventions.
47
48
* Non-managed service → Requires `publicAccess` to be enabled; resolves from the deployment’s public URL.
48
49
49
-
## Authentication and authorization
50
+
## Authentication and authorization (optional)
50
51
51
-
The embedded view inherits authentication and authorization from the Quix platform: no separate login is required, and the same user/environment permissions apply.
52
-
When an embedded view loads, the Plugin system injects the Quix user token into the iframe. The UI uses this token to call the backend securely.
52
+
> **Note**
53
+
> Authentication is **not required**. If your frontend app doesn’t need it, you can ignore this section.
54
+
> The details below are only useful if you want your embedded app to reuse Quix’s authentication and authorization system, so it follows the same user and environment permissions.
55
+
56
+
When used, the embedded view inherits authentication and authorization from the Quix platform: no separate login is required, and the same user/environment permissions apply.
57
+
58
+
When an embedded view loads, the Plugin system injects the Quix user token into the iframe. The UI can then use this token to call the backend securely.
53
59
54
60
### How the token is injected in the embedded view
0 commit comments