mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-23 06:05:45 +08:00
783 lines
38 KiB
HTML
783 lines
38 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class OpenIddictServerAspNetCoreBuilder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictServerAspNetCoreBuilder
|
|
">
|
|
<meta name="generator" content="docfx 2.56.6.0">
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../images/logo.png" alt="">
|
|
</a> </div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder">
|
|
|
|
|
|
<h1 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder" class="text-break">Class OpenIddictServerAspNetCoreBuilder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Exposes the necessary methods required to configure
|
|
the OpenIddict server ASP.NET Core integration.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">OpenIddictServerAspNetCoreBuilder</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Microsoft.Extensions.DependencyInjection.html">Microsoft.Extensions.DependencyInjection</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictServerAspNetCoreBuilder</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder__ctor_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.#ctor*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder__ctor_IServiceCollection_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.#ctor(IServiceCollection)">OpenIddictServerAspNetCoreBuilder(IServiceCollection)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder(IServiceCollection services)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IServiceCollection</span></td>
|
|
<td><span class="parametername">services</span></td>
|
|
<td><p>The services collection.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Services_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Services*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Services" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Services">Services</h4>
|
|
<div class="markdown level1 summary"><p>Gets the services collection.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IServiceCollection Services { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">IServiceCollection</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Configure_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Configure*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Configure_Action_OpenIddictServerAspNetCoreOptions__" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Configure(Action{OpenIddictServerAspNetCoreOptions})">Configure(Action<OpenIddictServerAspNetCoreOptions>)</h4>
|
|
<div class="markdown level1 summary"><p>Amends the default OpenIddict server ASP.NET Core configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder Configure(Action<OpenIddictServerAspNetCoreOptions> configuration)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Action</span><<span class="xref">OpenIddictServerAspNetCoreOptions</span>></td>
|
|
<td><span class="parametername">configuration</span></td>
|
|
<td><p>The delegate used to configure the OpenIddict options.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Configure_Action_OpenIddictServerAspNetCoreOptions___remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This extension can be safely called multiple times.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_DisableTransportSecurityRequirement_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.DisableTransportSecurityRequirement*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_DisableTransportSecurityRequirement" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.DisableTransportSecurityRequirement">DisableTransportSecurityRequirement()</h4>
|
|
<div class="markdown level1 summary"><p>Disables the transport security requirement (HTTPS).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder DisableTransportSecurityRequirement()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableAuthorizationEndpointPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableAuthorizationEndpointPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableAuthorizationEndpointPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableAuthorizationEndpointPassthrough">EnableAuthorizationEndpointPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables the pass-through mode for the OpenID Connect authorization endpoint.
|
|
When the pass-through mode is used, OpenID Connect requests are initially handled by OpenIddict.
|
|
Once validated, the rest of the request processing pipeline is invoked, so that OpenID Connect requests
|
|
can be handled at a later stage (in a custom middleware or in a MVC controller, for instance).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableAuthorizationEndpointPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableAuthorizationRequestCaching_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableAuthorizationRequestCaching*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableAuthorizationRequestCaching" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableAuthorizationRequestCaching">EnableAuthorizationRequestCaching()</h4>
|
|
<div class="markdown level1 summary"><p>Enables authorization request caching, so that authorization requests
|
|
are automatically stored in the distributed cache, which allows flowing
|
|
large payloads across requests. Enabling this option is recommended
|
|
when using external authentication providers or when large GET or POST
|
|
OpenID Connect authorization requests support is required.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableAuthorizationRequestCaching()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableErrorPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableErrorPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableErrorPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableErrorPassthrough">EnableErrorPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables error pass-through support, so that the rest of the request processing pipeline is
|
|
automatically invoked when returning an error from the interactive authorization and logout endpoints.
|
|
When this option is enabled, special logic must be added to these actions to handle errors, that can be
|
|
retrieved using <see cref="!:OpenIddictServerAspNetCoreHelpers.GetOpenIddictServerResponse(HttpContext)"></see>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableErrorPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableErrorPassthrough_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>Important: the error pass-through mode cannot be used when the status code pages integration is enabled.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableLogoutEndpointPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableLogoutEndpointPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableLogoutEndpointPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableLogoutEndpointPassthrough">EnableLogoutEndpointPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables the pass-through mode for the OpenID Connect logout endpoint.
|
|
When the pass-through mode is used, OpenID Connect requests are initially handled by OpenIddict.
|
|
Once validated, the rest of the request processing pipeline is invoked, so that OpenID Connect requests
|
|
can be handled at a later stage (in a custom middleware or in a MVC controller, for instance).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableLogoutEndpointPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableLogoutRequestCaching_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableLogoutRequestCaching*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableLogoutRequestCaching" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableLogoutRequestCaching">EnableLogoutRequestCaching()</h4>
|
|
<div class="markdown level1 summary"><p>Enables logout request caching, so that logout requests
|
|
are automatically stored in the distributed cache.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableLogoutRequestCaching()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableStatusCodePagesIntegration_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableStatusCodePagesIntegration*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableStatusCodePagesIntegration" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableStatusCodePagesIntegration">EnableStatusCodePagesIntegration()</h4>
|
|
<div class="markdown level1 summary"><p>Enables status code pages integration support. Once enabled, errors
|
|
generated by the interactive endpoints can be handled by ASP.NET Core.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableStatusCodePagesIntegration()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableTokenEndpointPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableTokenEndpointPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableTokenEndpointPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableTokenEndpointPassthrough">EnableTokenEndpointPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables the pass-through mode for the OpenID Connect token endpoint.
|
|
When the pass-through mode is used, OpenID Connect requests are initially handled by OpenIddict.
|
|
Once validated, the rest of the request processing pipeline is invoked, so that OpenID Connect requests
|
|
can be handled at a later stage (in a custom middleware or in a MVC controller, for instance).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableTokenEndpointPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableUserinfoEndpointPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableUserinfoEndpointPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableUserinfoEndpointPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableUserinfoEndpointPassthrough">EnableUserinfoEndpointPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables the pass-through mode for the OpenID Connect userinfo endpoint.
|
|
When the pass-through mode is used, OpenID Connect requests are initially handled by OpenIddict.
|
|
Once validated, the rest of the request processing pipeline is invoked, so that OpenID Connect requests
|
|
can be handled at a later stage (in a custom middleware or in a MVC controller, for instance).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableUserinfoEndpointPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableVerificationEndpointPassthrough_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableVerificationEndpointPassthrough*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_EnableVerificationEndpointPassthrough" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.EnableVerificationEndpointPassthrough">EnableVerificationEndpointPassthrough()</h4>
|
|
<div class="markdown level1 summary"><p>Enables the pass-through mode for the OpenID Connect user verification endpoint.
|
|
When the pass-through mode is used, OpenID Connect requests are initially handled by OpenIddict.
|
|
Once validated, the rest of the request processing pipeline is invoked, so that OpenID Connect requests
|
|
can be handled at a later stage (in a custom middleware or in a MVC controller, for instance).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder EnableVerificationEndpointPassthrough()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Equals_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Equals*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_Equals_System_Object_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.Equals(System.Object)">Equals(Object)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Object</span></td>
|
|
<td><span class="parametername">obj</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.Equals(System.Object)</span></div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_GetHashCode_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.GetHashCode*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_GetHashCode" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.GetHashCode">GetHashCode()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.GetHashCode()</span></div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetAuthorizationRequestCachingPolicy_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetAuthorizationRequestCachingPolicy*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetAuthorizationRequestCachingPolicy_DistributedCacheEntryOptions_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetAuthorizationRequestCachingPolicy(DistributedCacheEntryOptions)">SetAuthorizationRequestCachingPolicy(DistributedCacheEntryOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the caching policy used by the authorization endpoint.
|
|
Note: the specified policy is only used when caching is explicitly enabled.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder SetAuthorizationRequestCachingPolicy(DistributedCacheEntryOptions policy)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">DistributedCacheEntryOptions</span></td>
|
|
<td><span class="parametername">policy</span></td>
|
|
<td><p>The caching policy.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetLogoutRequestCachingPolicy_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetLogoutRequestCachingPolicy*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetLogoutRequestCachingPolicy_DistributedCacheEntryOptions_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetLogoutRequestCachingPolicy(DistributedCacheEntryOptions)">SetLogoutRequestCachingPolicy(DistributedCacheEntryOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the caching policy used by the logout endpoint.
|
|
Note: the specified policy is only used when caching is explicitly enabled.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder SetLogoutRequestCachingPolicy(DistributedCacheEntryOptions policy)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">DistributedCacheEntryOptions</span></td>
|
|
<td><span class="parametername">policy</span></td>
|
|
<td><p>The caching policy.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetRealm_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetRealm*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_SetRealm_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.SetRealm(System.String)">SetRealm(String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the realm returned to the caller as part of the WWW-Authenticate header.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictServerAspNetCoreBuilder SetRealm(string realm)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">realm</span></td>
|
|
<td><p>The issuer address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.html">OpenIddictServerAspNetCoreBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_ToString_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.ToString*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictServerAspNetCoreBuilder_ToString" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictServerAspNetCoreBuilder.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.Object.ToString()</span></div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|