mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 08:57:37 +08:00
495 lines
24 KiB
HTML
495 lines
24 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 OpenIddictServerAspNetCoreOptions
|
|||
|
|
</title>
|
|||
|
|
<meta name="viewport" content="width=device-width">
|
|||
|
|
<meta name="title" content="Class OpenIddictServerAspNetCoreOptions
|
|||
|
|
">
|
|||
|
|
<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="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h1 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions" class="text-break">Class OpenIddictServerAspNetCoreOptions
|
|||
|
|
</h1>
|
|||
|
|
<div class="markdown level0 summary"><p>Provides various settings needed to configure the OpenIddict ASP.NET Core server 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">OpenIddictServerAspNetCoreOptions</span></div>
|
|||
|
|
</div>
|
|||
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Server.AspNetCore.html">OpenIddict.Server.AspNetCore</a></h6>
|
|||
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|||
|
|
<h5 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_syntax">Syntax</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictServerAspNetCoreOptions : AuthenticationSchemeOptions</code></pre>
|
|||
|
|
</div>
|
|||
|
|
<h3 id="properties">Properties
|
|||
|
|
</h3>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_AuthorizationRequestCachingPolicy_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.AuthorizationRequestCachingPolicy*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_AuthorizationRequestCachingPolicy" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.AuthorizationRequestCachingPolicy">AuthorizationRequestCachingPolicy</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets the caching policy used by the authorization endpoint.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public DistributedCacheEntryOptions AuthorizationRequestCachingPolicy { get; set; }</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">DistributedCacheEntryOptions</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_DisableTransportSecurityRequirement_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.DisableTransportSecurityRequirement*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_DisableTransportSecurityRequirement" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.DisableTransportSecurityRequirement">DisableTransportSecurityRequirement</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether incoming requests arriving on insecure endpoints should be rejected.
|
|||
|
|
By default, this property is set to <code>false</code> to help mitigate man-in-the-middle attacks.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public bool DisableTransportSecurityRequirement { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableAuthorizationEndpointPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableAuthorizationEndpointPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableAuthorizationEndpointPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableAuthorizationEndpointPassthrough">EnableAuthorizationEndpointPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the pass-through mode is enabled for the 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 bool EnableAuthorizationEndpointPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableAuthorizationRequestCaching_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableAuthorizationRequestCaching*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableAuthorizationRequestCaching" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableAuthorizationRequestCaching">EnableAuthorizationRequestCaching</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether requests received by the authorization endpoint
|
|||
|
|
should be cached. When enabled, 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 bool EnableAuthorizationRequestCaching { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableErrorPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableErrorPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableErrorPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableErrorPassthrough">EnableErrorPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether OpenIddict should allow the rest of the request processing pipeline
|
|||
|
|
to be 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 bool EnableErrorPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<h5 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_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="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableLogoutEndpointPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableLogoutEndpointPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableLogoutEndpointPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableLogoutEndpointPassthrough">EnableLogoutEndpointPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the pass-through mode is enabled for the 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 bool EnableLogoutEndpointPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableLogoutRequestCaching_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableLogoutRequestCaching*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableLogoutRequestCaching" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableLogoutRequestCaching">EnableLogoutRequestCaching</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether requests received by the logout endpoint should be cached.
|
|||
|
|
When enabled, authorization 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 bool EnableLogoutRequestCaching { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableStatusCodePagesIntegration_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableStatusCodePagesIntegration*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableStatusCodePagesIntegration" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableStatusCodePagesIntegration">EnableStatusCodePagesIntegration</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether integration with the status code pages
|
|||
|
|
middleware should be enabled or not. Once enabled, errors generated by the OpenIddict
|
|||
|
|
interactive endpoints (e.g authorization or logout) 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 bool EnableStatusCodePagesIntegration { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableTokenEndpointPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableTokenEndpointPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableTokenEndpointPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableTokenEndpointPassthrough">EnableTokenEndpointPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the pass-through mode is enabled for the 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 bool EnableTokenEndpointPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableUserinfoEndpointPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableUserinfoEndpointPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableUserinfoEndpointPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableUserinfoEndpointPassthrough">EnableUserinfoEndpointPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the pass-through mode is enabled for the 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 bool EnableUserinfoEndpointPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableVerificationEndpointPassthrough_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableVerificationEndpointPassthrough*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_EnableVerificationEndpointPassthrough" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.EnableVerificationEndpointPassthrough">EnableVerificationEndpointPassthrough</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether the pass-through mode is enabled for the 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 bool EnableVerificationEndpointPassthrough { get; set; }</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">System.Boolean</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_LogoutRequestCachingPolicy_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.LogoutRequestCachingPolicy*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_LogoutRequestCachingPolicy" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.LogoutRequestCachingPolicy">LogoutRequestCachingPolicy</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets the caching policy used by the logout endpoint.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="markdown level1 conceptual"></div>
|
|||
|
|
<h5 class="decalaration">Declaration</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public DistributedCacheEntryOptions LogoutRequestCachingPolicy { get; set; }</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">DistributedCacheEntryOptions</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_Realm_" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.Realm*"></a>
|
|||
|
|
<h4 id="OpenIddict_Server_AspNetCore_OpenIddictServerAspNetCoreOptions_Realm" data-uid="OpenIddict.Server.AspNetCore.OpenIddictServerAspNetCoreOptions.Realm">Realm</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Gets or sets the optional "realm" value 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 string Realm { get; set; }</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">System.String</span></td>
|
|||
|
|
<td></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</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>
|