---
title: BolMiddleware API reference
summary: Index of the public types, view components, and Razor views in BolMiddleware.
status: draft
owner: SAIF IT Core Services
last_reviewed: 2026-10-12
library: BolMiddleware
reference_type: package
---

# BolMiddleware API reference

This page lists every public type in `BolMiddleware`, including the view components and the Razor layouts, partials, and component views that consumers use.

## Types
| Type | Namespace | Kind | Summary |
| --- | --- | --- | --- |
| [BolRazorLayoutStartup](bolmiddleware/BolRazorLayoutStartup.md) | `BolMiddleware` | Class | Startup base that registers BOL services and enables legacy authentication. |
| [BolServiceExtensions](bolmiddleware/BolServiceExtensions.md) | `BolMiddleware` | Static class | `RegisterBolServices` dependency injection extension. |
| [BolServiceSessionExtensions](bolmiddleware/BolServiceSessionExtensions.md) | `BolMiddleware` | Static class | Session helpers for context, menu, and policy header. |
| [SessionExtensions](bolmiddleware/SessionExtensions.md) | `BolMiddleware` | Static class | Generic JSON session helpers. |
| [HeaderExtensions](bolmiddleware.extensions/HeaderExtensions.md) | `BolMiddleware.Extensions` | Static class | Policy association dropdown builder. |
| [BolContextModel](bolmiddleware.models/BolContextModel.md) | `BolMiddleware.Models` | Abstract class | Context resolution and saving page model. |
| [BolMenuModel](bolmiddleware.models/BolMenuModel.md) | `BolMiddleware.Models` | Abstract class | Menu loading and navigation page model. |
| [BolPolicyModel](bolmiddleware.models/BolPolicyModel.md) | `BolMiddleware.Models` | Abstract class | Policy header and access page model. |
| [ContextCookie](bolmiddleware.models/ContextCookie.md) | `BolMiddleware.Models` | Class | Payload of the `BolContext` cookie. |
| [IAppMap](bolmiddleware.models.menumodels/IAppMap.md) | `BolMiddleware.Models.MenuModels` | Interface | Application menu mapping contract. |
| [BasicAppMap](bolmiddleware.models.menumodels/BasicAppMap.md) | `BolMiddleware.Models.MenuModels` | Class | Options bound from the `BasicAppMap` section. |
| [BolMenuViewModel](bolmiddleware.models.menumodels/BolMenuViewModel.md) | `BolMiddleware.Models.MenuModels` | Class | View model for the menu views. |
| [BolNavItemViewModel](bolmiddleware.models.menumodels/BolNavItemViewModel.md) | `BolMiddleware.Models.MenuModels` | Class | View model for one menu item. |
| [Constants](bolmiddleware.contracts/Constants.md) | `BolMiddleware.Contracts` | Class | Session, form, and query key names. |
| [NavigationOptions](bolmiddleware.contracts/NavigationOptions.md) | `BolMiddleware.Contracts` | Class | Navigation target and URL builder. |
| [CurrentUserType](bolmiddleware.enums/CurrentUserType.md) | `BolMiddleware.Enums` | Enum | Internal, external, or unknown user. |
| [CurrentUserState](bolmiddleware.enums/CurrentUserState.md) | `BolMiddleware.Enums` | Enum | New or validated external user state. |
| [IBolServicesContainer](bolmiddleware.services/IBolServicesContainer.md) | `BolMiddleware.Services` | Interface | Bundle of services for page models. |
| [BolServicesContainer](bolmiddleware.services/BolServicesContainer.md) | `BolMiddleware.Services` | Class | Default services container. |
| [ISecurityService](bolmiddleware.services.security/ISecurityService.md) | `BolMiddleware.Services.Security` | Interface | User, role, and policy access checks. |
| [SecurityService](bolmiddleware.services.security/SecurityService.md) | `BolMiddleware.Services.Security` | Class | Security checks through the platform clients. |
| [UserType](bolmiddleware.services.security/UserType.md) | `BolMiddleware.Services.Security` | Record | Unused user category flags. |
| [IWebContextService](bolmiddleware.services.context/IWebContextService.md) | `BolMiddleware.Services.Context` | Interface | Web context persistence contract. |
| [WebContextService](bolmiddleware.services.context/WebContextService.md) | `BolMiddleware.Services.Context` | Class | BOL Context API facade. |
| [WebContextExtensions](bolmiddleware.services.context/WebContextExtensions.md) | `BolMiddleware.Services.Context` | Static class | Content detection and logging text. |
| [PolicyModelExtensions](bolmiddleware.services.context/PolicyModelExtensions.md) | `BolMiddleware.Services.Context` | Static class | Number parsing and header-to-context copy. |
| [IPolicyHeaderService](bolmiddleware.services.headers.policy/IPolicyHeaderService.md) | `BolMiddleware.Services.Headers.Policy` | Interface | Policy header loading contract. |
| [PolicyHeaderService](bolmiddleware.services.headers.policy/PolicyHeaderService.md) | `BolMiddleware.Services.Headers.Policy` | Class | Policy Header API facade. |
| [IMenuService](bolmiddleware.services.menu/IMenuService.md) | `BolMiddleware.Services.Menu` | Interface | Menu loading contract. |
| [MenuService](bolmiddleware.services.menu/MenuService.md) | `BolMiddleware.Services.Menu` | Class | BOL Menu API facade. |
| [ICookieService](bolmiddleware.services.cookieservice/ICookieService.md) | `BolMiddleware.Services.CookieService` | Interface | Cookie read and write contract. |
| [CookieService](bolmiddleware.services.cookieservice/CookieService.md) | `BolMiddleware.Services.CookieService` | Class | Cookie implementation. |
| [IRequestHelper](bolmiddleware.services.request/IRequestHelper.md) | `BolMiddleware.Services.Request` | Interface | Request value reader contract. |
| [RequestHelper](bolmiddleware.services.request/RequestHelper.md) | `BolMiddleware.Services.Request` | Class | Request value reader. |
| [IContextCookieHelper](bolmiddleware.contextcookiehelper/IContextCookieHelper.md) | `BolMiddleware.ContextCookieHelper` | Interface | User setting contract for the context cookie. |
| [ContextCookieHelperService](bolmiddleware.contextcookiehelper/ContextCookieHelperService.md) | `BolMiddleware.ContextCookieHelper` | Class | User setting implementation. |
| [BolPolicyHeaderViewComponent](bolmiddleware.components/BolPolicyHeaderViewComponent.md) | `BolMiddleware.Components` | View component | Policy header bar. |
| [BolSideMenuViewComponent](bolmiddleware.components/BolSideMenuViewComponent.md) | `BolMiddleware.Components` | View component | Side menu. |
| [BolTopMenuViewComponent](bolmiddleware.components/BolTopMenuViewComponent.md) | `BolMiddleware.Components` | View component | Top menu. |
| [_PolicyLayout](bolmiddleware.pages.shared/_PolicyLayout.md) | `BolMiddleware.Pages.Shared` | Layout | Full policy page layout. |
| [_PolicyOnlyLayout](bolmiddleware.pages.shared/_PolicyOnlyLayout.md) | `BolMiddleware.Pages.Shared` | Layout | Policy header without menus. |
| [_ContextOnlyLayout](bolmiddleware.pages.shared/_ContextOnlyLayout.md) | `BolMiddleware.Pages.Shared` | Layout | Context form only. |
| [_MenuOnlyLayout](bolmiddleware.pages.shared/_MenuOnlyLayout.md) | `BolMiddleware.Pages.Shared` | Layout | Menus without policy header. |
| [_BolCoreScriptsHeaderPartial](bolmiddleware.pages.shared/_BolCoreScriptsHeaderPartial.md) | `BolMiddleware.Pages.Shared` | Partial view | Head scripts and analytics. |
| [_BolCoreScriptsPartial](bolmiddleware.pages.shared/_BolCoreScriptsPartial.md) | `BolMiddleware.Pages.Shared` | Partial view | Navigation script. |
| [_BolMenuItemPartial](bolmiddleware.pages.shared/_BolMenuItemPartial.md) | `BolMiddleware.Pages.Shared` | Partial view | One menu entry. |
| [_BolPageHeaderPartial](bolmiddleware.pages.shared/_BolPageHeaderPartial.md) | `BolMiddleware.Pages.Shared` | Partial view | Header bar with profile links. |
| [_SaifFooterPartial](bolmiddleware.pages.shared/_SaifFooterPartial.md) | `BolMiddleware.Pages.Shared` | Partial view | Footer. |
| [Error](bolmiddleware.pages.shared/Error.md) | `BolMiddleware.Pages.Shared` | View | Error banner. |
| [BolPolicyHeader](bolmiddleware.pages.components/BolPolicyHeader.md) | `BolMiddleware.Pages.Components` | Component view | Policy header default view. |
| [BolSideMenu](bolmiddleware.pages.components/BolSideMenu.md) | `BolMiddleware.Pages.Components` | Component view | Side menu default view. |
| [BolTopMenu](bolmiddleware.pages.components/BolTopMenu.md) | `BolMiddleware.Pages.Components` | Component view | Top menu default view. |

## Related documentation
- [Index](../index.md)
- [Overview](../overview.md)
- [Architecture](../architecture.md)
- [Dependencies](../dependencies.md)
- [Configuration](../configuration.md)
- [Operations and processes](../operations-processes.md)
- [Business rules](../business-rules.md)
- [Security and authorization](../security-authorization.md)
- [Service registration](../service-registration.md)

## Sources
- src/BolMiddleware/BolRazorLayoutStartup.cs
- src/BolMiddleware/Extensions/BolMiddlewareExtensions.cs
- src/BolMiddleware/Models/BolContextModel.cs
- src/BolMiddleware/Services/BolServicesContainer.cs
- src/BolMiddleware/ViewComponents/BolPolicyHeaderViewComponent.cs
- src/BolMiddleware/Pages/Shared/_PolicyLayout.cshtml