CreatePermissionRuleOptions

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

Signature:

export type CreatePermissionRuleOptions<TRef extends PermissionResourceRef, TParams extends PermissionRuleParams> = TRef extends PermissionResourceRef<infer IResource, infer IQuery, any> ? {
    name: string;
    description: string;
    resourceRef: TRef;
    paramsSchema?: z.ZodSchema<TParams>;
    apply(resource: IResource, params: NoInfer<TParams>): boolean;
    toQuery(params: NoInfer<TParams>): PermissionCriteria<IQuery>;
} : never;

References: PermissionResourceRef, PermissionRuleParams, PermissionCriteria