Skip to main content

CreatePermissionRuleOptions

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

Signature:

export type CreatePermissionRuleOptions<TResource, TQuery, TQueryOutput extends TQuery, TResourceType extends string, TParams extends PermissionRuleParams> = {
name: string;
description: string;
resourceRef: PermissionResourceRef<TResource, TQuery, TResourceType>;
paramsSchema?: z.ZodSchema<TParams>;
apply(resource: TResource, params: NoInfer<TParams>): boolean;
toQuery(params: NoInfer<TParams>): PermissionCriteria<TQueryOutput>;
};

References: PermissionRuleParams, PermissionResourceRef, PermissionCriteria