mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-23 06:05:45 +08:00
1329 lines
57 KiB
HTML
1329 lines
57 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 OpenIddictValidationBuilder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictValidationBuilder
|
|
">
|
|
<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.OpenIddictValidationBuilder">
|
|
|
|
|
|
<h1 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder" class="text-break">Class OpenIddictValidationBuilder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Exposes the necessary methods required to configure the OpenIddict validation services.</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">OpenIddictValidationBuilder</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_OpenIddictValidationBuilder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictValidationBuilder</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder__ctor_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.#ctor*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder__ctor_IServiceCollection_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.#ctor(IServiceCollection)">OpenIddictValidationBuilder(IServiceCollection)</h4>
|
|
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder(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_OpenIddictValidationBuilder_Services_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.Services*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Services" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.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_OpenIddictValidationBuilder_AddAudiences_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddAudiences*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddAudiences_System_String___" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddAudiences(System.String[])">AddAudiences(String[])</h4>
|
|
<div class="markdown level1 summary"><p>Registers the specified values as valid audiences. Setting the audiences 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 OpenIddictValidationBuilder AddAudiences(params string[] audiences)</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">audiences</span></td>
|
|
<td><p>The audiences valid for this resource server.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_Assembly_System_String_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(Assembly,System.String,System.String)">AddEncryptionCertificate(Assembly, String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate retrieved from an embedded resource.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(Assembly assembly, string resource, string password)</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">Assembly</span></td>
|
|
<td><span class="parametername">assembly</span></td>
|
|
<td><p>The assembly containing the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">resource</span></td>
|
|
<td><p>The name of the embedded resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">password</span></td>
|
|
<td><p>The password used to open the certificate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_Assembly_System_String_System_String_X509KeyStorageFlags_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(Assembly,System.String,System.String,X509KeyStorageFlags)">AddEncryptionCertificate(Assembly, String, String, X509KeyStorageFlags)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate retrieved from an embedded resource.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(Assembly assembly, string resource, string password, X509KeyStorageFlags flags)</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">Assembly</span></td>
|
|
<td><span class="parametername">assembly</span></td>
|
|
<td><p>The assembly containing the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">resource</span></td>
|
|
<td><p>The name of the embedded resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">password</span></td>
|
|
<td><p>The password used to open the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">X509KeyStorageFlags</span></td>
|
|
<td><span class="parametername">flags</span></td>
|
|
<td><p>An enumeration of flags indicating how and where to store the private key of the certificate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_Stream_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(Stream,System.String)">AddEncryptionCertificate(Stream, String)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate extracted from a stream.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(Stream stream, string password)</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">Stream</span></td>
|
|
<td><span class="parametername">stream</span></td>
|
|
<td><p>The stream containing the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">password</span></td>
|
|
<td><p>The password used to open the certificate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_Stream_System_String_X509KeyStorageFlags_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(Stream,System.String,X509KeyStorageFlags)">AddEncryptionCertificate(Stream, String, X509KeyStorageFlags)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate extracted from a stream.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(Stream stream, string password, X509KeyStorageFlags flags)</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">Stream</span></td>
|
|
<td><span class="parametername">stream</span></td>
|
|
<td><p>The stream containing the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">password</span></td>
|
|
<td><p>The password used to open the certificate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">X509KeyStorageFlags</span></td>
|
|
<td><span class="parametername">flags</span></td>
|
|
<td><p>An enumeration of flags indicating how and where
|
|
to store the private key of the certificate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(System.String)">AddEncryptionCertificate(String)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate retrieved from the X.509 user or machine store.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(string thumbprint)</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">thumbprint</span></td>
|
|
<td><p>The thumbprint of the certificate used to identify it in the X.509 store.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_System_String_StoreName_StoreLocation_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(System.String,StoreName,StoreLocation)">AddEncryptionCertificate(String, StoreName, StoreLocation)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate retrieved from the specified X.509 store.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(string thumbprint, StoreName name, StoreLocation location)</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">thumbprint</span></td>
|
|
<td><p>The thumbprint of the certificate used to identify it in the X.509 store.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">StoreName</span></td>
|
|
<td><span class="parametername">name</span></td>
|
|
<td><p>The name of the X.509 store.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">StoreLocation</span></td>
|
|
<td><span class="parametername">location</span></td>
|
|
<td><p>The location of the X.509 store.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCertificate_X509Certificate2_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCertificate(X509Certificate2)">AddEncryptionCertificate(X509Certificate2)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption certificate.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCertificate(X509Certificate2 certificate)</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">X509Certificate2</span></td>
|
|
<td><span class="parametername">certificate</span></td>
|
|
<td><p>The encryption certificate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCredentials_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCredentials*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionCredentials_EncryptingCredentials_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionCredentials(EncryptingCredentials)">AddEncryptionCredentials(EncryptingCredentials)</h4>
|
|
<div class="markdown level1 summary"><p>Registers encryption credentials.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionCredentials(EncryptingCredentials credentials)</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">EncryptingCredentials</span></td>
|
|
<td><span class="parametername">credentials</span></td>
|
|
<td><p>The encrypting credentials.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionKey_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionKey*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEncryptionKey_SecurityKey_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEncryptionKey(SecurityKey)">AddEncryptionKey(SecurityKey)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an encryption key.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEncryptionKey(SecurityKey key)</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">SecurityKey</span></td>
|
|
<td><span class="parametername">key</span></td>
|
|
<td><p>The security key.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEventHandler_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEventHandler*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEventHandler_OpenIddictValidationHandlerDescriptor_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEventHandler(OpenIddictValidationHandlerDescriptor)">AddEventHandler(OpenIddictValidationHandlerDescriptor)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an event handler using the specified descriptor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEventHandler(OpenIddictValidationHandlerDescriptor descriptor)</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">OpenIddictValidationHandlerDescriptor</span></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The handler descriptor.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEventHandler_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEventHandler*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_AddEventHandler__1_Action_OpenIddictValidationHandlerDescriptor_Builder___0___" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.AddEventHandler``1(Action{OpenIddictValidationHandlerDescriptor.Builder{``0}})">AddEventHandler<TContext>(Action<OpenIddictValidationHandlerDescriptor.Builder<TContext>>)</h4>
|
|
<div class="markdown level1 summary"><p>Registers an event handler using the specified configuration delegate.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder AddEventHandler<TContext>(Action<OpenIddictValidationHandlerDescriptor.Builder<TContext>> configuration)
|
|
where TContext : OpenIddictValidationEvents.BaseContext</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">OpenIddictValidationHandlerDescriptor.Builder</span><TContext>></td>
|
|
<td><span class="parametername">configuration</span></td>
|
|
<td><p>The configuration delegate.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="typeParameters">Type Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="parametername">TContext</span></td>
|
|
<td><p>The event context type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Configure_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.Configure*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Configure_Action_OpenIddictValidationOptions__" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.Configure(Action{OpenIddictValidationOptions})">Configure(Action<OpenIddictValidationOptions>)</h4>
|
|
<div class="markdown level1 summary"><p>Amends the default OpenIddict validation configuration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder Configure(Action<OpenIddictValidationOptions> 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">OpenIddictValidationOptions</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Configure_Action_OpenIddictValidationOptions___remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This extension can be safely called multiple times.</p>
|
|
</div>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_EnableAuthorizationEntryValidation_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.EnableAuthorizationEntryValidation*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_EnableAuthorizationEntryValidation" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.EnableAuthorizationEntryValidation">EnableAuthorizationEntryValidation()</h4>
|
|
<div class="markdown level1 summary"><p>Enables authorization validation so that a database call is made for each API request
|
|
to ensure the authorization associated with the access token is still valid.
|
|
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 OpenIddictValidationBuilder EnableAuthorizationEntryValidation()</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_EnableTokenEntryValidation_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.EnableTokenEntryValidation*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_EnableTokenEntryValidation" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.EnableTokenEntryValidation">EnableTokenEntryValidation()</h4>
|
|
<div class="markdown level1 summary"><p>Enables token validation so that a database call is made for each API request
|
|
to ensure the token entry associated with the access token is still valid.
|
|
Note: enabling this option may have an impact on performance but is required
|
|
when the OpenIddict server is configured to use 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 OpenIddictValidationBuilder EnableTokenEntryValidation()</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Equals_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.Equals*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_Equals_System_Object_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.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_OpenIddictValidationBuilder_GetHashCode_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.GetHashCode*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_GetHashCode" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.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_OpenIddictValidationBuilder_RemoveEventHandler_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.RemoveEventHandler*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_RemoveEventHandler_OpenIddictValidationHandlerDescriptor_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.RemoveEventHandler(OpenIddictValidationHandlerDescriptor)">RemoveEventHandler(OpenIddictValidationHandlerDescriptor)</h4>
|
|
<div class="markdown level1 summary"><p>Removes the event handler that matches the specified descriptor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder RemoveEventHandler(OpenIddictValidationHandlerDescriptor descriptor)</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">OpenIddictValidationHandlerDescriptor</span></td>
|
|
<td><span class="parametername">descriptor</span></td>
|
|
<td><p>The descriptor corresponding to the handler to remove.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetClientId_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetClientId*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetClientId_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetClientId(System.String)">SetClientId(String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the client identifier client_id used when communicating
|
|
with the remote authorization server (e.g for introspection).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder SetClientId(string identifier)</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">identifier</span></td>
|
|
<td><p>The client identifier.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetClientSecret_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetClientSecret*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetClientSecret_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetClientSecret(System.String)">SetClientSecret(String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the client identifier client_secret used when communicating
|
|
with the remote authorization server (e.g for introspection).</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder SetClientSecret(string secret)</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">secret</span></td>
|
|
<td><p>The client secret.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetConfiguration_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetConfiguration*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetConfiguration_OpenIdConnectConfiguration_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetConfiguration(OpenIdConnectConfiguration)">SetConfiguration(OpenIdConnectConfiguration)</h4>
|
|
<div class="markdown level1 summary"><p>Sets a static OpenID Connect server configuration, that will be used to
|
|
resolve the metadata/introspection endpoints and the issuer signing keys.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder SetConfiguration(OpenIdConnectConfiguration 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">OpenIdConnectConfiguration</span></td>
|
|
<td><span class="parametername">configuration</span></td>
|
|
<td><p>The server configuration.</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetIssuer_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetIssuer*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetIssuer_System_String_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetIssuer(System.String)">SetIssuer(String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the issuer address, which is used to determine the actual location of the
|
|
OAuth 2.0/OpenID Connect configuration document when using provider discovery.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder SetIssuer(string address)</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">address</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetIssuer_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetIssuer*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_SetIssuer_Uri_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.SetIssuer(Uri)">SetIssuer(Uri)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the issuer address, which is used to determine the actual location of the
|
|
OAuth 2.0/OpenID Connect configuration document when using provider discovery.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder SetIssuer(Uri address)</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">Uri</span></td>
|
|
<td><span class="parametername">address</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_ToString_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.ToString*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_ToString" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.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>
|
|
|
|
|
|
<a id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_UseIntrospection_" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.UseIntrospection*"></a>
|
|
<h4 id="Microsoft_Extensions_DependencyInjection_OpenIddictValidationBuilder_UseIntrospection" data-uid="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.UseIntrospection">UseIntrospection()</h4>
|
|
<div class="markdown level1 summary"><p>Configures OpenIddict to use introspection instead of local/direct validation.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationBuilder UseIntrospection()</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.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a></td>
|
|
<td><p>The <a class="xref" href="Microsoft.Extensions.DependencyInjection.OpenIddictValidationBuilder.html">OpenIddictValidationBuilder</a>.</p>
|
|
</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>
|