@backstage/plugin-permission-react
Home > @backstage/plugin-permission-react
Classes
| Class | Description |
|---|---|
| IdentityPermissionApi | The default implementation of the PermissionApi, which simply calls the authorize method of the given PermissionClient. |
Functions
| Function | Description |
|---|---|
| RequirePermission(props) | A boundary that only renders its child elements if the user has the specified permission. While loading, nothing will be rendered. If the user does not have permission, the |
| usePermission(input) | React hook utility for authorization. Given either a non-resource Permission or a ResourcePermission and an optional resourceRef, it will return whether or not access is allowed (for the given resource, if resourceRef is provided). See for more details. The resourceRef field is optional to allow calling this hook with an entity that might be loading asynchronously, but when resourceRef is not supplied, the value of Note: This hook uses stale-while-revalidate to help avoid flicker in UI elements that would be conditionally rendered based on the |
Variables
| Variable | Description |
|---|---|
| permissionApiRef | A Backstage ApiRef for the Permission API. See https://backstage.io/docs/api/utility-apis for more information on Backstage ApiRefs. |
| PermissionedRoute | Returns a React Router Route which only renders the element when authorized. If unauthorized, the Route will render a NotFoundErrorPage (see AppComponents). |
Type Aliases
| Type Alias | Description |
|---|---|
| AsyncPermissionResult | |
| PermissionApi | This API is used by various frontend utilities that allow developers to implement authorization within their frontend plugins. A plugin developer will likely not have to interact with this API or its implementations directly, but rather with the aforementioned utility components/hooks. |
| RequirePermissionProps | Properties for RequirePermission() |