Skip to content

OidcRouteOptions Class

Route templates for the OpenID Connect and OAuth 2.0 endpoints mapped by MapOidcEndpoints(this IEndpointRouteBuilder, string).

C#
public sealed class OidcRouteOptions

Inheritance System.Object → OidcRouteOptions

Remarks

The MVC integration encodes these paths as tokenized templates resolved through the MVC application model. Minimal API has no application-model hook, so the same configurability is expressed as a plain options object: a host overrides any path through the options pattern, and the endpoints are mapped against the resolved literals at startup. Defaults mirror the MVC fallbacks (/connect/* and /.well-known/*).

Properties

OidcRouteOptions.Authorize Property

The authorization endpoint (OpenID Connect Core 3.1).

C#
public string Authorize { get; set; }

Property Value

System.String

OidcRouteOptions.BackChannelAuthentication Property

The backchannel authentication endpoint (OpenID Connect CIBA).

C#
public string BackChannelAuthentication { get; set; }

Property Value

System.String

OidcRouteOptions.CheckSession Property

The check-session endpoint (OpenID Connect Session Management 4).

C#
public string CheckSession { get; set; }

Property Value

System.String

OidcRouteOptions.Configuration Property

The OpenID Provider configuration document (OpenID Connect Discovery 4).

C#
public string Configuration { get; set; }

Property Value

System.String

OidcRouteOptions.DeviceAuthorization Property

The device authorization endpoint (RFC 8628).

C#
public string DeviceAuthorization { get; set; }

Property Value

System.String

OidcRouteOptions.EndSession Property

The end-session (logout) endpoint (OpenID Connect Session Management 5).

C#
public string EndSession { get; set; }

Property Value

System.String

OidcRouteOptions.Introspection Property

The token introspection endpoint (RFC 7662).

C#
public string Introspection { get; set; }

Property Value

System.String

OidcRouteOptions.Keys Property

The JSON Web Key Set endpoint (OpenID Connect Discovery 4).

C#
public string Keys { get; set; }

Property Value

System.String

OidcRouteOptions.OAuthAuthorizationServer Property

The OAuth 2.0 Authorization Server Metadata document (RFC 8414 §3) - the same metadata served at Configuration, also exposed at the oauth-authorization-server suffix.

C#
public string OAuthAuthorizationServer { get; set; }

Property Value

System.String

OidcRouteOptions.PushedAuthorizationRequest Property

The pushed authorization request endpoint (RFC 9126).

C#
public string PushedAuthorizationRequest { get; set; }

Property Value

System.String

OidcRouteOptions.Register Property

The dynamic client registration endpoint (OpenID Connect Dynamic Client Registration).

C#
public string Register { get; set; }

Property Value

System.String

OidcRouteOptions.RegisterClient Property

The client configuration endpoint (RFC 7592). Must contain the {clientId} route parameter.

C#
public string RegisterClient { get; set; }

Property Value

System.String

OidcRouteOptions.Revocation Property

The token revocation endpoint (RFC 7009).

C#
public string Revocation { get; set; }

Property Value

System.String

OidcRouteOptions.Token Property

The token endpoint (OpenID Connect Core 3.1.3, OAuth 2.0 RFC 6749 3.2).

C#
public string Token { get; set; }

Property Value

System.String

OidcRouteOptions.UserInfo Property

The UserInfo endpoint (OpenID Connect Core 5.3).

C#
public string UserInfo { get; set; }

Property Value

System.String