Skip to main content
Version: Next

PermissionPolicy

Home > @backstage/plugin-permission-node > PermissionPolicy

A policy to evaluate authorization requests for any permissioned action performed in Backstage.

Signature:

export interface PermissionPolicy 

Remarks

This takes as input a permission and an optional Backstage identity, and should return ALLOW if the user is permitted to execute that action; otherwise DENY. For permissions relating to resources, such a catalog entities, a conditional response can also be returned. This states that the action is allowed if the conditions provided hold true.

Conditions are a rule, and parameters to evaluate against that rule. For example, the rule might be isOwner and the parameters a collection of entityRefs; if one of the entityRefs matches the owner field on a catalog entity, this would resolve to ALLOW.

Methods

Method

Description

handle(request, user)