Skip to main content

PermissionClient

Home > @backstage/plugin-permission-common > PermissionClient

An isomorphic client for requesting authorization for Backstage permissions.

Signature:

class PermissionClient implements PermissionEvaluator 

Implements: PermissionEvaluator

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the PermissionClient class

Methods

MethodModifiersDescription
authorize(requests, options)Evaluates Permissions and returns a definitive decision.
authorizeConditional(queries, options)Evaluates ResourcePermissions and returns both definitive and conditional decisions, depending on the configured PermissionPolicy. This method is useful when the caller needs more control over the processing of conditional decisions. For example, a plugin backend may want to use conditions in a database query instead of evaluating each resource in memory.