Interface PermissionEvaluator

A client interacting with the permission backend can implement this evaluator interface.

interface PermissionEvaluator {
    authorize(
        requests: AuthorizePermissionRequest[],
        options?: EvaluatorRequestOptions & { _ignored?: undefined },
    ): Promise<DefinitivePolicyDecision[]>;
    authorizeConditional(
        requests: QueryPermissionRequest[],
        options?: EvaluatorRequestOptions & { _ignored?: undefined },
    ): Promise<PolicyDecision[]>;
}

Hierarchy (View Summary)

PermissionEvaluator
- PermissionsService

Implemented by

PermissionClient

Index

Methods

authorize authorizeConditional

Methods

authorize

authorize(
requests: AuthorizePermissionRequest[],
options?: EvaluatorRequestOptions & { _ignored?: undefined },
): Promise<DefinitivePolicyDecision[]>
Evaluates Permissions and returns a definitive decision.
Parameters
- requests: AuthorizePermissionRequest[]
- Optionaloptions: EvaluatorRequestOptions & { _ignored?: undefined }
Returns Promise<DefinitivePolicyDecision[]>
- Defined in plugins/permission-common/src/types/api.ts:263

authorizeConditional

authorizeConditional(
requests: QueryPermissionRequest[],
options?: EvaluatorRequestOptions & { _ignored?: undefined },
): Promise<PolicyDecision[]>
Evaluates ResourcePermissions and returns both definitive and conditional decisions, depending on the configured @backstage/plugin-permission-node#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.
Parameters
- requests: QueryPermissionRequest[]
- Optionaloptions: EvaluatorRequestOptions & { _ignored?: undefined }
Returns Promise<PolicyDecision[]>
- Defined in plugins/permission-common/src/types/api.ts:276