Class ServerPermissionClient

A thin wrapper around @backstage/plugin-permission-common#PermissionClient that allows all service-to-service requests.

Implements

PermissionsService

Index

Methods

authorize authorizeConditional fromConfig

Methods

authorize

authorize(
requests: AuthorizePermissionRequest[],
options?: PermissionsServiceRequestOptions,
): Promise<DefinitivePolicyDecision[]>
Evaluates @backstage/plugin-permission-common#Permission | Permissions and returns definitive decisions.
Parameters
- requests: AuthorizePermissionRequest[]
- Optionaloptions: PermissionsServiceRequestOptions
Returns Promise<DefinitivePolicyDecision[]>
Remarks
The returned array has the same number of items, in the same order, as the given requests.
Implementation of PermissionsService.authorize
- Defined in plugins/permission-node/src/ServerPermissionClient.ts:94

authorizeConditional

authorizeConditional(
queries: QueryPermissionRequest[],
options?: PermissionsServiceRequestOptions,
): Promise<PolicyDecision[]>
Evaluates @backstage/plugin-permission-common#ResourcePermission | ResourcePermissions and returns both definitive and conditional decisions, depending on the configured @backstage/plugin-permission-node#PermissionPolicy.
Parameters
- queries: QueryPermissionRequest[]
- Optionaloptions: PermissionsServiceRequestOptions
Returns Promise<PolicyDecision[]>
Remarks
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 @backstage/plugin-permission-common#PermissionCriteria | conditions in a database query instead of evaluating each resource in memory.

The returned array has the same number of items, in the same order, as the given requests.
Implementation of PermissionsService.authorizeConditional
- Defined in plugins/permission-node/src/ServerPermissionClient.ts:77

`Static`fromConfig

fromConfig(
config: Config,
options: { auth: AuthService; discovery: DiscoveryService },
): ServerPermissionClient
Parameters
- config: Config
- options: { auth: AuthService; discovery: DiscoveryService }
Returns ServerPermissionClient
- Defined in plugins/permission-node/src/ServerPermissionClient.ts:48