2021-01-18 02:24:47 +08:00
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<!--[if IE]><![endif]-->
|
|
|
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
|
|
|
|
<title>Namespace OpenIddict.Server
|
|
|
|
|
|
</title>
|
|
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
|
|
|
|
<meta name="title" content="Namespace OpenIddict.Server
|
|
|
|
|
|
">
|
2021-04-09 18:51:20 +08:00
|
|
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
2021-01-18 02:24:47 +08:00
|
|
|
|
|
|
|
|
|
|
<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">
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="OpenIddict_Server" data-uid="OpenIddict.Server" class="text-break">Namespace OpenIddict.Server
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
<div class="markdown level0 summary"></div>
|
|
|
|
|
|
<div class="markdown level0 conceptual"></div>
|
|
|
|
|
|
<div class="markdown level0 remarks"></div>
|
|
|
|
|
|
<h3 id="classes">Classes
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.AttachTokenDigests.html">AttachTokenDigests</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of generating and attaching the hashes of
|
|
|
|
|
|
the access token and authorization code to the identity token principal.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.AttachTokenParameters.html">AttachTokenParameters</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of attaching the tokens and their metadata to the sign-in response.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.BeautifyUserCode.html">BeautifyUserCode</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of beautifying the user code returned to the client.
|
|
|
|
|
|
Note: this handler is not used when the degraded mode is enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.CreateIdentityTokenEntry.html">CreateIdentityTokenEntry</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of creating an identity token entry.
|
|
|
|
|
|
Note: this handler is not used when the degraded mode is enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.GenerateIdentityModelIdentityToken.html">GenerateIdentityModelIdentityToken</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of generating an identity token using IdentityModel.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerConfiguration.html">OpenIddictServerConfiguration</a></h4>
|
|
|
|
|
|
<section><p>Contains the methods required to ensure that the OpenIddict server configuration is valid.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerConstants.html">OpenIddictServerConstants</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerConstants.Properties.html">OpenIddictServerConstants.Properties</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerDispatcher.html">OpenIddictServerDispatcher</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.html">OpenIddictServerEvents</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.html">OpenIddictServerEvents.ApplyAuthorizationResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the authorization response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyConfigurationResponseContext.html">OpenIddictServerEvents.ApplyConfigurationResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the configuration response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyCryptographyResponseContext.html">OpenIddictServerEvents.ApplyCryptographyResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the cryptography response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyDeviceResponseContext.html">OpenIddictServerEvents.ApplyDeviceResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the device response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyIntrospectionResponseContext.html">OpenIddictServerEvents.ApplyIntrospectionResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the introspection response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyLogoutResponseContext.html">OpenIddictServerEvents.ApplyLogoutResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the logout response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyRevocationResponseContext.html">OpenIddictServerEvents.ApplyRevocationResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the revocation response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyTokenResponseContext.html">OpenIddictServerEvents.ApplyTokenResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the token response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyUserinfoResponseContext.html">OpenIddictServerEvents.ApplyUserinfoResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the userinfo response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyVerificationResponseContext.html">OpenIddictServerEvents.ApplyVerificationResponseContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called before the verification response is returned to the caller.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractAuthorizationRequestContext.html">OpenIddictServerEvents.ExtractAuthorizationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the authorization endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the authorization request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractConfigurationRequestContext.html">OpenIddictServerEvents.ExtractConfigurationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the configuration endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the configuration request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractCryptographyRequestContext.html">OpenIddictServerEvents.ExtractCryptographyRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the cryptography endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the cryptography request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractDeviceRequestContext.html">OpenIddictServerEvents.ExtractDeviceRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the device endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the device request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractIntrospectionRequestContext.html">OpenIddictServerEvents.ExtractIntrospectionRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the introspection endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the introspection request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractLogoutRequestContext.html">OpenIddictServerEvents.ExtractLogoutRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the logout endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the logout request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractRevocationRequestContext.html">OpenIddictServerEvents.ExtractRevocationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the revocation endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the revocation request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractTokenRequestContext.html">OpenIddictServerEvents.ExtractTokenRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the token endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the token request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractUserinfoRequestContext.html">OpenIddictServerEvents.ExtractUserinfoRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the userinfo endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the userinfo request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ExtractVerificationRequestContext.html">OpenIddictServerEvents.ExtractVerificationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the verification endpoint to give the user code
|
|
|
|
|
|
a chance to manually extract the verification request from the ambient HTTP context.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleAuthorizationRequestContext.html">OpenIddictServerEvents.HandleAuthorizationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated authorization request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleConfigurationRequestContext.html">OpenIddictServerEvents.HandleConfigurationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated configuration request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleCryptographyRequestContext.html">OpenIddictServerEvents.HandleCryptographyRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated cryptography request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleDeviceRequestContext.html">OpenIddictServerEvents.HandleDeviceRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated device request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleIntrospectionRequestContext.html">OpenIddictServerEvents.HandleIntrospectionRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated introspection request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleLogoutRequestContext.html">OpenIddictServerEvents.HandleLogoutRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated logout request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleRevocationRequestContext.html">OpenIddictServerEvents.HandleRevocationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated revocation request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleTokenRequestContext.html">OpenIddictServerEvents.HandleTokenRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated token request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleUserinfoRequestContext.html">OpenIddictServerEvents.HandleUserinfoRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated userinfo request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.HandleVerificationRequestContext.html">OpenIddictServerEvents.HandleVerificationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each validated verification request
|
|
|
|
|
|
to allow the user code to decide how the request should be handled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessAuthenticationContext.html">OpenIddictServerEvents.ProcessAuthenticationContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing an authentication operation.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessChallengeContext.html">OpenIddictServerEvents.ProcessChallengeContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing a challenge response.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessErrorContext.html">OpenIddictServerEvents.ProcessErrorContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing an errored response.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessRequestContext.html">OpenIddictServerEvents.ProcessRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing an incoming request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessSignInContext.html">OpenIddictServerEvents.ProcessSignInContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing a sign-in response.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ProcessSignOutContext.html">OpenIddictServerEvents.ProcessSignOutContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called when processing a sign-out response.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateAuthorizationRequestContext.html">OpenIddictServerEvents.ValidateAuthorizationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the authorization endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateConfigurationRequestContext.html">OpenIddictServerEvents.ValidateConfigurationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the configuration endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateCryptographyRequestContext.html">OpenIddictServerEvents.ValidateCryptographyRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the cryptography endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateDeviceRequestContext.html">OpenIddictServerEvents.ValidateDeviceRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the device endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateIntrospectionRequestContext.html">OpenIddictServerEvents.ValidateIntrospectionRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the introspection endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateLogoutRequestContext.html">OpenIddictServerEvents.ValidateLogoutRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the logout endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateRevocationRequestContext.html">OpenIddictServerEvents.ValidateRevocationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the revocation endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateTokenRequestContext.html">OpenIddictServerEvents.ValidateTokenRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the token endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateUserinfoRequestContext.html">OpenIddictServerEvents.ValidateUserinfoRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the userinfo endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ValidateVerificationRequestContext.html">OpenIddictServerEvents.ValidateVerificationRequestContext</a></h4>
|
|
|
|
|
|
<section><p>Represents an event called for each request to the verification endpoint
|
|
|
|
|
|
to determine if the request is valid and should continue to be processed.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerFactory.html">OpenIddictServerFactory</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandler-1.html">OpenIddictServerHandler<TContext></a></h4>
|
|
|
|
|
|
<section><p>Represents a handler able to process <code data-dev-comment-type="typeparamref" class="typeparamref">TContext</code> events.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerDescriptor.html">OpenIddictServerHandlerDescriptor</a></h4>
|
|
|
|
|
|
<section><p>Represents an immutable descriptor of an OpenIddict server event handler.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerDescriptor.Builder-1.html">OpenIddictServerHandlerDescriptor.Builder<TContext></a></h4>
|
|
|
|
|
|
<section><p>Contains methods allowing to build a descriptor instance.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.html">OpenIddictServerHandlerFilters</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireAccessTokenGenerated.html">OpenIddictServerHandlerFilters.RequireAccessTokenGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no access token is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireAuthorizationCodeGenerated.html">OpenIddictServerHandlerFilters.RequireAuthorizationCodeGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no authorization code is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireAuthorizationRequest.html">OpenIddictServerHandlerFilters.RequireAuthorizationRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not an authorization request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireAuthorizationStorageEnabled.html">OpenIddictServerHandlerFilters.RequireAuthorizationStorageEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if authorization storage was not enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireClientIdParameter.html">OpenIddictServerHandlerFilters.RequireClientIdParameter</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers when no client identifier is received.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireConfigurationRequest.html">OpenIddictServerHandlerFilters.RequireConfigurationRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a configuration request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireCryptographyRequest.html">OpenIddictServerHandlerFilters.RequireCryptographyRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a cryptography request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireDegradedModeDisabled.html">OpenIddictServerHandlerFilters.RequireDegradedModeDisabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the degraded mode was not enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireDeviceCodeGenerated.html">OpenIddictServerHandlerFilters.RequireDeviceCodeGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no device code is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireDeviceRequest.html">OpenIddictServerHandlerFilters.RequireDeviceRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a device request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireEndpointPermissionsEnabled.html">OpenIddictServerHandlerFilters.RequireEndpointPermissionsEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if endpoint permissions were disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireGrantTypePermissionsEnabled.html">OpenIddictServerHandlerFilters.RequireGrantTypePermissionsEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if grant type permissions were disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireIdentityTokenGenerated.html">OpenIddictServerHandlerFilters.RequireIdentityTokenGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no identity token is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireIntrospectionRequest.html">OpenIddictServerHandlerFilters.RequireIntrospectionRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not an introspection request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireLogoutRequest.html">OpenIddictServerHandlerFilters.RequireLogoutRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a logout request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequirePostLogoutRedirectUriParameter.html">OpenIddictServerHandlerFilters.RequirePostLogoutRedirectUriParameter</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers when no post_logout_redirect_uri is received.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireReferenceAccessTokensEnabled.html">OpenIddictServerHandlerFilters.RequireReferenceAccessTokensEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if reference access tokens are disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireReferenceRefreshTokensEnabled.html">OpenIddictServerHandlerFilters.RequireReferenceRefreshTokensEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if reference refresh tokens are disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireRefreshTokenGenerated.html">OpenIddictServerHandlerFilters.RequireRefreshTokenGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no refresh token is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireResponseTypePermissionsEnabled.html">OpenIddictServerHandlerFilters.RequireResponseTypePermissionsEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if response type permissions were disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireRevocationRequest.html">OpenIddictServerHandlerFilters.RequireRevocationRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a revocation request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireScopePermissionsEnabled.html">OpenIddictServerHandlerFilters.RequireScopePermissionsEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if scope permissions were disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireScopeValidationEnabled.html">OpenIddictServerHandlerFilters.RequireScopeValidationEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if scope validation was not enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireSlidingRefreshTokenExpirationEnabled.html">OpenIddictServerHandlerFilters.RequireSlidingRefreshTokenExpirationEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if sliding refresh token expiration was disabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireTokenRequest.html">OpenIddictServerHandlerFilters.RequireTokenRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a token request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireTokenStorageEnabled.html">OpenIddictServerHandlerFilters.RequireTokenStorageEnabled</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if token storage was not enabled.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireUserCodeGenerated.html">OpenIddictServerHandlerFilters.RequireUserCodeGenerated</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if no user code is generated.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireUserinfoRequest.html">OpenIddictServerHandlerFilters.RequireUserinfoRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a userinfo request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerFilters.RequireVerificationRequest.html">OpenIddictServerHandlerFilters.RequireVerificationRequest</a></h4>
|
|
|
|
|
|
<section><p>Represents a filter that excludes the associated handlers if the request is not a verification request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHelpers.html">OpenIddictServerHelpers</a></h4>
|
|
|
|
|
|
<section><p>Exposes extensions simplifying the integration with the OpenIddict server services.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerOptions.html">OpenIddictServerOptions</a></h4>
|
|
|
|
|
|
<section><p>Provides various settings needed to configure the OpenIddict server handler.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerTransaction.html">OpenIddictServerTransaction</a></h4>
|
|
|
|
|
|
<section><p>Represents the context associated with an OpenID Connect server request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.ValidateSignOutDemand.html">ValidateSignOutDemand</a></h4>
|
|
|
|
|
|
<section><p>Contains the logic responsible of ensuring that the sign-out demand
|
|
|
|
|
|
is compatible with the type of the endpoint that handled the request.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h3 id="interfaces">Interfaces
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.IOpenIddictServerDispatcher.html">IOpenIddictServerDispatcher</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.IOpenIddictServerFactory.html">IOpenIddictServerFactory</a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.IOpenIddictServerHandler-1.html">IOpenIddictServerHandler<TContext></a></h4>
|
|
|
|
|
|
<section><p>Represents a handler able to process <code data-dev-comment-type="typeparamref" class="typeparamref">TContext</code> events.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.IOpenIddictServerHandlerFilter-1.html">IOpenIddictServerHandlerFilter<TContext></a></h4>
|
|
|
|
|
|
<section></section>
|
|
|
|
|
|
<h3 id="enums">Enums
|
|
|
|
|
|
</h3>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerEndpointType.html">OpenIddictServerEndpointType</a></h4>
|
|
|
|
|
|
<section><p>Represents the type of an OpenIddict server endpoint.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<h4><a class="xref" href="OpenIddict.Server.OpenIddictServerHandlerType.html">OpenIddictServerHandlerType</a></h4>
|
|
|
|
|
|
<section><p>Represents the type of an OpenIddict server handler.</p>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</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>
|
