Frontend permission docs for integrators (#11039)

* Frontend permission docs for integrators Signed-off-by: Joon Park <joonp@spotify.com> * Update docs/permission/frontend-integration.md Co-authored-by: Joe Porpeglia <josephp@spotify.com> Signed-off-by: Joon Park <joonp@spotify.com> Signed-off-by: Joon Park <joonp@spotify.com> Co-authored-by: Joe Porpeglia <josephp@spotify.com>
2022-09-21 13:56:37 +01:00
parent b27abf25f5
commit ff08f1d14e
2 changed files with 39 additions and 0 deletions
@@ -0,0 +1,38 @@
+---
+id: frontend-integration
+title: Frontend Integration
+description: How to place your Backstage frontend components behind authorization
+---
+
+Now that we understand how to [author a permission policy](./writing-a-policy.md), let's consider cases where we'll need to supplement our policy with authorization checks on the frontend.
+
+In most cases, actual functionality that live within various plugins will already have been placed behind authorization by the plugin authors. The permission backend will use your permission policy to return an authorization result, and the plugin frontend will correspondingly show/hide/disable the relevant UI component.
+
+However, there are some cases where the integrator needs to supplement the policy on the frontend. One example is app level routing.
+
+If your Backstage permission policy may return a `DENY` for users requesting the `catalogEntityCreatePermission`, it may make sense, for example, to remove access to the `/catalog-import` page entirely:
+
+```diff
+// packages/app/src/App.tsx
+
+...
+
+ import { PermissionedRoute } from '@backstage/plugin-permission-react';
+ import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common';
+
+...
+
+-     <Route path="/catalog-import" element={<CatalogImportPage />} />
+     <Route
+       path="/catalog-import"
+       element={
+         <RequirePermission permission={catalogEntityCreatePermission}>
+           <CatalogImportPage />
+         </RequirePermission>
+       }
+     />
+...
+
+```
+
+With this change, users who are denied the `catalogEntityCreatePermission` should now be unable to access the `/catalog-import` page.
@@ -286,6 +286,7 @@
      "permissions/concepts",
      "permissions/getting-started",
      "permissions/writing-a-policy",
+      "permissions/frontend-integration",
      "permissions/custom-rules",
      {
        "type": "subcategory",