openiddict-documentation/api/OpenIddict.Validation.OpenIddictValidationOptions.html
2021-01-17 17:45:35 +00:00

535 lines
23 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 OpenIddictValidationOptions
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OpenIddictValidationOptions
">
<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.Validation.OpenIddictValidationOptions">
<h1 id="OpenIddict_Validation_OpenIddictValidationOptions" data-uid="OpenIddict.Validation.OpenIddictValidationOptions" class="text-break">Class OpenIddictValidationOptions
</h1>
<div class="markdown level0 summary"><p>Provides various settings needed to configure the OpenIddict validation handler.</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">OpenIddictValidationOptions</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</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.ToString()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Validation.html">OpenIddict.Validation</a></h6>
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
<h5 id="OpenIddict_Validation_OpenIddictValidationOptions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class OpenIddictValidationOptions</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_Audiences_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Audiences*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_Audiences" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Audiences">Audiences</h4>
<div class="markdown level1 summary"><p>Gets the intended audiences of this resource server.
Setting this property is recommended when the authorization
server issues access tokens for multiple distinct resource servers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public HashSet&lt;string&gt; Audiences { 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">HashSet</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_ClientId_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ClientId*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_ClientId" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ClientId">ClientId</h4>
<div class="markdown level1 summary"><p>Gets or sets the client identifier sent to the authorization server when using remote validation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ClientId { 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>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_ClientSecret_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ClientSecret*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_ClientSecret" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ClientSecret">ClientSecret</h4>
<div class="markdown level1 summary"><p>Gets or sets the client secret sent to the authorization server when using remote validation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ClientSecret { 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>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_Configuration_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Configuration*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_Configuration" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Configuration">Configuration</h4>
<div class="markdown level1 summary"><p>Gets or sets the OAuth 2.0/OpenID Connect static server configuration, if applicable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OpenIdConnectConfiguration? Configuration { 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.Nullable</span>&lt;<span class="xref">OpenIdConnectConfiguration</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_ConfigurationManager_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ConfigurationManager*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_ConfigurationManager" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ConfigurationManager">ConfigurationManager</h4>
<div class="markdown level1 summary"><p>Gets or sets the configuration manager used to retrieve
and cache the OAuth 2.0/OpenID Connect server configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IConfigurationManager&lt;OpenIdConnectConfiguration&gt; ConfigurationManager { 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">IConfigurationManager</span>&lt;<span class="xref">OpenIdConnectConfiguration</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_EnableAuthorizationEntryValidation_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EnableAuthorizationEntryValidation*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_EnableAuthorizationEntryValidation" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EnableAuthorizationEntryValidation">EnableAuthorizationEntryValidation</h4>
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether a database call is made
to validate the authorization entry associated with the received tokens.
Note: enabling this option may have an impact on performance and
can only be used with an OpenIddict-based authorization server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnableAuthorizationEntryValidation { 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_Validation_OpenIddictValidationOptions_EnableTokenEntryValidation_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EnableTokenEntryValidation*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_EnableTokenEntryValidation" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EnableTokenEntryValidation">EnableTokenEntryValidation</h4>
<div class="markdown level1 summary"><p>Gets or sets a boolean indicating whether a database call is made
to validate the token entry associated with the received tokens.
Note: enabling this option may have an impact on performance but
is required when the OpenIddict server emits reference tokens.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool EnableTokenEntryValidation { 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_Validation_OpenIddictValidationOptions_EncryptionCredentials_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EncryptionCredentials*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_EncryptionCredentials" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.EncryptionCredentials">EncryptionCredentials</h4>
<div class="markdown level1 summary"><p>Gets the list of encryption credentials used by the OpenIddict validation services.
Note: the encryption credentials are not used to protect/unprotect tokens issued
by ASP.NET Core Data Protection, that uses its own key ring, configured separately.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;EncryptingCredentials&gt; EncryptionCredentials { 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">System.Collections.Generic.List</span>&lt;<span class="xref">EncryptingCredentials</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="OpenIddict_Validation_OpenIddictValidationOptions_EncryptionCredentials_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Note: OpenIddict automatically sorts the credentials based on the following algorithm:
<ul><li>Symmetric keys are always preferred when they can be used for the operation (e.g token encryption).</li><li>X.509 keys are always preferred to non-X.509 asymmetric keys.</li><li>X.509 keys with the furthest expiration date are preferred.</li><li>X.509 keys whose backing certificate is not yet valid are never preferred.</li></ul></p>
</div>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_Handlers_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Handlers*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_Handlers" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Handlers">Handlers</h4>
<div class="markdown level1 summary"><p>Gets the list of the handlers responsible of processing the OpenIddict validation operations.
Note: the list is automatically sorted based on the order assigned to each handler descriptor.
As such, it MUST NOT be mutated after options initialization to preserve the exact order.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public List&lt;OpenIddictValidationHandlerDescriptor&gt; Handlers { 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">System.Collections.Generic.List</span>&lt;<a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerDescriptor.html">OpenIddictValidationHandlerDescriptor</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_Issuer_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Issuer*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_Issuer" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.Issuer">Issuer</h4>
<div class="markdown level1 summary"><p>Gets or sets the absolute URL of the OAuth 2.0/OpenID Connect server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Uri? Issuer { 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.Nullable</span>&lt;<span class="xref">Uri</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_JsonWebTokenHandler_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.JsonWebTokenHandler*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_JsonWebTokenHandler" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.JsonWebTokenHandler">JsonWebTokenHandler</h4>
<div class="markdown level1 summary"><p>Gets or sets the JWT handler used to protect and unprotect tokens.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public JsonWebTokenHandler JsonWebTokenHandler { 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">JsonWebTokenHandler</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_MetadataAddress_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.MetadataAddress*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_MetadataAddress" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.MetadataAddress">MetadataAddress</h4>
<div class="markdown level1 summary"><p>Gets or sets the URL of the OAuth 2.0/OpenID Connect server discovery endpoint.
When the URL is relative, <a class="xref" href="OpenIddict.Validation.OpenIddictValidationOptions.html#OpenIddict_Validation_OpenIddictValidationOptions_Issuer">Issuer</a> must be set and absolute.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Uri? MetadataAddress { 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.Nullable</span>&lt;<span class="xref">Uri</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_TokenValidationParameters_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.TokenValidationParameters*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_TokenValidationParameters" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.TokenValidationParameters">TokenValidationParameters</h4>
<div class="markdown level1 summary"><p>Gets the token validation parameters used by the OpenIddict validation services.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TokenValidationParameters TokenValidationParameters { 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">TokenValidationParameters</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Validation_OpenIddictValidationOptions_ValidationType_" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ValidationType*"></a>
<h4 id="OpenIddict_Validation_OpenIddictValidationOptions_ValidationType" data-uid="OpenIddict.Validation.OpenIddictValidationOptions.ValidationType">ValidationType</h4>
<div class="markdown level1 summary"><p>Gets or sets the type of validation used by the OpenIddict validation services.
By default, local validation is always used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OpenIddictValidationType ValidationType { 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><a class="xref" href="OpenIddict.Validation.OpenIddictValidationType.html">OpenIddictValidationType</a></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>