AspNetCore.HealthChecks.OpenIdConnectServer 9.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package AspNetCore.HealthChecks.OpenIdConnectServer --version 9.0.0                

                    
                

            
NuGet\Install-Package AspNetCore.HealthChecks.OpenIdConnectServer -Version 9.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AspNetCore.HealthChecks.OpenIdConnectServer" Version="9.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AspNetCore.HealthChecks.OpenIdConnectServer --version 9.0.0                

                    
                

            
#r "nuget: AspNetCore.HealthChecks.OpenIdConnectServer, 9.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install AspNetCore.HealthChecks.OpenIdConnectServer as a Cake Addin
#addin nuget:?package=AspNetCore.HealthChecks.OpenIdConnectServer&version=9.0.0

// Install AspNetCore.HealthChecks.OpenIdConnectServer as a Cake Tool
#tool nuget:?package=AspNetCore.HealthChecks.OpenIdConnectServer&version=9.0.0

OpenID Connect Server Health Check

This health check verifies that an OpenID Connect server (like Duende IdentityServer, Microsoft Entra ID, etc.) is responding. Internally, it downloads the discovery document and checks existence of document's properties.

Example Usage

Use the following snippet to register an OpenID Connect server accessible at https://myoidcserver.com.

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddOpenIdConnectServer(oidcSvrUri: new Uri("https://myoidcserver.com"));
}

Use the following snippet to additionally specify a different discovery endpoint path. The default value if not specified is .well-known/openid-configuration.

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddOpenIdConnectServer(
            oidcSvrUri: new Uri("https://myoidcserver.com"),
            discoverConfigurationSegment: "discovery/endpoint");
}

You can additionally specify the following parameters:

  • name: The health check name. Default if not specified is oidcserver.
  • failureStatus: The HealthStatus that should be reported when the health check fails. Default is HealthStatus.Unhealthy.
  • tags: A list of tags that can be used to filter sets of health checks.
  • timeout: A System.TimeSpan representing the timeout of the check.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (20)

Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.OpenIdConnectServer:

Package Downloads
Sitko.Core.Auth.IdentityServer

Sitko.Core is a set of libraries to help build .NET Core applications fast
Skoruba.IdentityServer4.Admin.UI

The package with UI for the administration of the IdentityServer4
Skoruba.Duende.IdentityServer.Admin.UI

The package with UI for the administration of the Duende IdentityServer
Capp.Extensions.DependencyInjection

Package Description
SunnyMehr.HealthMonitor

Package Description

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on AspNetCore.HealthChecks.OpenIdConnectServer:

Repository Stars
skoruba/IdentityServer4.Admin
The administration for the IdentityServer4 and Asp.Net Core Identity
skoruba/Duende.IdentityServer.Admin
The administration for the Duende IdentityServer and Asp.Net Core Identity ⚡
sitkoru/Sitko.Core
Sitko.Core is a set of libraries to help build .NET Core applications fast
Version Downloads Last updated
9.0.0 734 12/19/2024
8.0.1 509,212 4/2/2024
8.0.0 290,385 12/15/2023
7.0.0 486,861 7/30/2023
7.0.0-rc2.4 12,514 3/13/2023
7.0.0-rc2.3 2,841 1/14/2023
7.0.0-rc2.2 789 12/27/2022
7.0.0-rc2.1 135 12/27/2022
6.0.2 2,426,235 2/28/2022
6.0.1 344,970 12/29/2021
6.0.1-rc1.3 4,705 11/5/2021
6.0.0 10,467 12/29/2021
5.0.1 852,430 1/5/2021
5.0.0 4,197 12/29/2020
5.0.0-preview1 2,046 11/22/2020
3.1.1 1,215,711 4/17/2020
3.1.0 118,217 4/9/2020
3.0.0 1,507,271 9/24/2019
2.2.2 558,947 12/18/2018
2.2.1 12,799 12/5/2018
2.2.0 8,248 11/14/2018