Update the documentation pages

This commit is contained in:
OpenIddict Bot
2021-04-09 10:51:20 +00:00
parent 365b4fabb0
commit 8bd2df081c
834 changed files with 2153 additions and 113840 deletions

View File

@@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace OpenIddict.Server.Owin
">
<meta name="generator" content="docfx 2.56.6.0">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -135,145 +135,6 @@ pass-through mode was not enabled for the userinfo endpoint.</p>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlerFilters.RequireVerificationEndpointPassthroughEnabled.html">OpenIddictServerOwinHandlerFilters.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.Owin.OpenIddictServerOwinHandlers.html">OpenIddictServerOwinHandlers</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.AttachCacheControlHeader-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.AttachHostChallengeError.html">OpenIddictServerOwinHandlers.AttachHostChallengeError</a></h4>
<section><p>Contains the logic responsible of attaching the error details using the OWIN authentication properties.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.AttachHttpResponseCode-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.AttachWwwAuthenticateHeader-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.html">OpenIddictServerOwinHandlers.Authentication</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.CacheRequestParameters.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.ProcessFormPostResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.ProcessFragmentResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.ProcessQueryResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.RemoveCachedRequest.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Authentication.RestoreCachedRequestParameters.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Device.html">OpenIddictServerOwinHandlers.Device</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Discovery.html">OpenIddictServerOwinHandlers.Discovery</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.EnablePassthroughMode-2.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Exchange.html">OpenIddictServerOwinHandlers.Exchange</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ExtractAccessToken-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ExtractBasicAuthenticationCredentials-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ExtractGetOrPostRequest-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ExtractGetRequest-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ExtractPostRequest-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.InferEndpointType.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.InferIssuerFromHost.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Introspection.html">OpenIddictServerOwinHandlers.Introspection</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessChallengeErrorResponse-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessEmptyResponse-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessHostRedirectionResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessJsonResponse-1.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessLocalErrorResponse-1.html">OpenIddictServerOwinHandlers.ProcessLocalErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses that must be returned as plain-text.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ProcessPassthroughErrorResponse-2.html">OpenIddictServerOwinHandlers.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 MVC action or a NancyFX module).
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Revocation.html">OpenIddictServerOwinHandlers.Revocation</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.html">OpenIddictServerOwinHandlers.Session</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.CacheRequestParameters.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.ProcessHostRedirectionResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.ProcessQueryResponse.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.RemoveCachedRequest.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Session.RestoreCachedRequestParameters.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.Userinfo.html">OpenIddictServerOwinHandlers.Userinfo</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinHandlers.ValidateTransportSecurityRequirement.html">OpenIddictServerOwinHandlers.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 OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Server.Owin.OpenIddictServerOwinMiddleware.html">OpenIddictServerOwinMiddleware</a></h4>
<section><p>Provides the entry point necessary to register the OpenIddict server handler in an OWIN pipeline.