Update the documentation pages

This commit is contained in:
OpenIddict Bot
2021-05-25 14:54:52 +00:00
parent 862254c066
commit 7226a46ddf
458 changed files with 112247 additions and 528 deletions

View File

@@ -139,6 +139,153 @@ pass-through mode was not enabled for the userinfo endpoint.</p>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlerFilters.RequireVerificationEndpointPassthroughEnabled.html">OpenIddictServerAspNetCoreHandlerFilters.RequireVerificationEndpointPassthroughEnabled</a></h4>
<section><p>Represents a filter that excludes the associated handlers if the
pass-through mode was not enabled for the verification endpoint.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.html">OpenIddictServerAspNetCoreHandlers</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.AttachCacheControlHeader-1.html">OpenIddictServerAspNetCoreHandlers.AttachCacheControlHeader&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching the appropriate HTTP response cache headers.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.AttachHostChallengeError.html">OpenIddictServerAspNetCoreHandlers.AttachHostChallengeError</a></h4>
<section><p>Contains the logic responsible of attaching the error details using the ASP.NET Core authentication properties.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.AttachHostParameters-1.html">OpenIddictServerAspNetCoreHandlers.AttachHostParameters&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching custom parameters stored in the ASP.NET Core authentication properties.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.AttachHttpResponseCode-1.html">OpenIddictServerAspNetCoreHandlers.AttachHttpResponseCode&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching an appropriate HTTP status code.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.AttachWwwAuthenticateHeader-1.html">OpenIddictServerAspNetCoreHandlers.AttachWwwAuthenticateHeader&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching errors details to the WWW-Authenticate header.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.html">OpenIddictServerAspNetCoreHandlers.Authentication</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.CacheRequestParameters.html">OpenIddictServerAspNetCoreHandlers.Authentication.CacheRequestParameters</a></h4>
<section><p>Contains the logic responsible of caching authorization requests, if applicable.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.ProcessFormPostResponse.html">OpenIddictServerAspNetCoreHandlers.Authentication.ProcessFormPostResponse</a></h4>
<section><p>Contains the logic responsible of processing authorization responses using the form_post response mode.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.ProcessFragmentResponse.html">OpenIddictServerAspNetCoreHandlers.Authentication.ProcessFragmentResponse</a></h4>
<section><p>Contains the logic responsible of processing authorization responses using the fragment response mode.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.ProcessQueryResponse.html">OpenIddictServerAspNetCoreHandlers.Authentication.ProcessQueryResponse</a></h4>
<section><p>Contains the logic responsible of processing authorization responses using the query response mode.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.RemoveCachedRequest.html">OpenIddictServerAspNetCoreHandlers.Authentication.RemoveCachedRequest</a></h4>
<section><p>Contains the logic responsible of removing cached authorization requests from the distributed cache.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Authentication.RestoreCachedRequestParameters.html">OpenIddictServerAspNetCoreHandlers.Authentication.RestoreCachedRequestParameters</a></h4>
<section><p>Contains the logic responsible of restoring cached requests from the request_id, if specified.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Device.html">OpenIddictServerAspNetCoreHandlers.Device</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Discovery.html">OpenIddictServerAspNetCoreHandlers.Discovery</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.EnablePassthroughMode-2.html">OpenIddictServerAspNetCoreHandlers.EnablePassthroughMode&lt;TContext, TFilter&gt;</a></h4>
<section><p>Contains the logic responsible of enabling the pass-through mode for the received request.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Exchange.html">OpenIddictServerAspNetCoreHandlers.Exchange</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ExtractAccessToken-1.html">OpenIddictServerAspNetCoreHandlers.ExtractAccessToken&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting an access token from the standard HTTP Authorization header.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ExtractBasicAuthenticationCredentials-1.html">OpenIddictServerAspNetCoreHandlers.ExtractBasicAuthenticationCredentials&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting client credentials from the standard HTTP Authorization header.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ExtractGetOrPostRequest-1.html">OpenIddictServerAspNetCoreHandlers.ExtractGetOrPostRequest&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting OpenID Connect requests from GET or POST HTTP requests.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ExtractGetRequest-1.html">OpenIddictServerAspNetCoreHandlers.ExtractGetRequest&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting OpenID Connect requests from GET HTTP requests.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ExtractPostRequest-1.html">OpenIddictServerAspNetCoreHandlers.ExtractPostRequest&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting OpenID Connect requests from POST HTTP requests.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.InferEndpointType.html">OpenIddictServerAspNetCoreHandlers.InferEndpointType</a></h4>
<section><p>Contains the logic responsible of inferring the endpoint type from the request address.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.InferIssuerFromHost.html">OpenIddictServerAspNetCoreHandlers.InferIssuerFromHost</a></h4>
<section><p>Contains the logic responsible of infering the issuer URL from the HTTP request host and validating it.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Introspection.html">OpenIddictServerAspNetCoreHandlers.Introspection</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessChallengeErrorResponse-1.html">OpenIddictServerAspNetCoreHandlers.ProcessChallengeErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing challenge responses that contain a WWW-Authenticate header.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessEmptyResponse-1.html">OpenIddictServerAspNetCoreHandlers.ProcessEmptyResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses that don&apos;t specify any parameter.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessHostRedirectionResponse.html">OpenIddictServerAspNetCoreHandlers.ProcessHostRedirectionResponse</a></h4>
<section><p>Contains the logic responsible of processing verification responses that should trigger a host redirection.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessJsonResponse-1.html">OpenIddictServerAspNetCoreHandlers.ProcessJsonResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses that must be returned as JSON.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessLocalErrorResponse-1.html">OpenIddictServerAspNetCoreHandlers.ProcessLocalErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing context responses that must be returned as plain-text.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessPassthroughErrorResponse-2.html">OpenIddictServerAspNetCoreHandlers.ProcessPassthroughErrorResponse&lt;TContext, TFilter&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses that must be handled by another
middleware in the pipeline at a later stage (e.g an ASP.NET Core MVC action or a NancyFX module).
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ProcessStatusCodePagesErrorResponse-1.html">OpenIddictServerAspNetCoreHandlers.ProcessStatusCodePagesErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses handled by the status code pages middleware.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Revocation.html">OpenIddictServerAspNetCoreHandlers.Revocation</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.html">OpenIddictServerAspNetCoreHandlers.Session</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.CacheRequestParameters.html">OpenIddictServerAspNetCoreHandlers.Session.CacheRequestParameters</a></h4>
<section><p>Contains the logic responsible of caching logout requests, if applicable.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.ProcessHostRedirectionResponse.html">OpenIddictServerAspNetCoreHandlers.Session.ProcessHostRedirectionResponse</a></h4>
<section><p>Contains the logic responsible of processing logout responses that should trigger a host redirection.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.ProcessQueryResponse.html">OpenIddictServerAspNetCoreHandlers.Session.ProcessQueryResponse</a></h4>
<section><p>Contains the logic responsible of processing logout responses.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.RemoveCachedRequest.html">OpenIddictServerAspNetCoreHandlers.Session.RemoveCachedRequest</a></h4>
<section><p>Contains the logic responsible of removing cached logout requests from the distributed cache.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Session.RestoreCachedRequestParameters.html">OpenIddictServerAspNetCoreHandlers.Session.RestoreCachedRequestParameters</a></h4>
<section><p>Contains the logic responsible of restoring cached requests from the request_id, if specified.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.Userinfo.html">OpenIddictServerAspNetCoreHandlers.Userinfo</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreHandlers.ValidateTransportSecurityRequirement.html">OpenIddictServerAspNetCoreHandlers.ValidateTransportSecurityRequirement</a></h4>
<section><p>Contains the logic responsible of rejecting OpenID Connect requests that don&apos;t use transport security.
Note: this handler is not used when the OpenID Connect request is not initially handled by ASP.NET Core.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.html">OpenIddictServerAspNetCoreOptions</a></h4>
<section><p>Provides various settings needed to configure the OpenIddict ASP.NET Core server integration.</p>