Skip to main content

PermissionsRegistryServiceAddResourceTypeOptions

Home > @backstage/backend-plugin-api > PermissionsRegistryServiceAddResourceTypeOptions

Options for adding a resource type to the permission system.

Signature:

export type PermissionsRegistryServiceAddResourceTypeOptions<TResourceType extends string, TResource, TQuery> = {
resourceRef: PermissionResourceRef<TResource, TQuery, TResourceType>;
permissions?: Array<Permission>;
rules: PermissionRule<NoInfer<TResource>, NoInfer<TQuery>, NoInfer<TResourceType>>[];
getResources?(resourceRefs: string[]): Promise<Array<NoInfer<TResource> | undefined>>;
};

References: PermissionResourceRef, Permission, PermissionRule