openiddict-documentation/api/OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.html
2021-01-17 18:24:47 +00:00

429 lines
19 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 OpenIddictServerEvents.ApplyAuthorizationResponseContext
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OpenIddictServerEvents.ApplyAuthorizationResponseContext
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.png" alt="">
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext">
<h1 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext" class="text-break">Class OpenIddictServerEvents.ApplyAuthorizationResponseContext
</h1>
<div class="markdown level0 summary"><p>Represents an event called before the authorization response is returned to the caller.</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"><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html">OpenIddictServerEvents.BaseContext</a></div>
<div class="level2"><a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseRequestContext.html">OpenIddictServerEvents.BaseRequestContext</a></div>
<div class="level3"><span class="xref">OpenIddictServerEvents.ApplyAuthorizationResponseContext</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseRequestContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseRequestContext_IsRequestHandled">OpenIddictServerEvents.BaseRequestContext.IsRequestHandled</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseRequestContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseRequestContext_IsRequestSkipped">OpenIddictServerEvents.BaseRequestContext.IsRequestSkipped</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseRequestContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseRequestContext_HandleRequest">OpenIddictServerEvents.BaseRequestContext.HandleRequest()</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseRequestContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseRequestContext_SkipRequest">OpenIddictServerEvents.BaseRequestContext.SkipRequest()</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseContext_Transaction">OpenIddictServerEvents.BaseContext.Transaction</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseContext_Issuer">OpenIddictServerEvents.BaseContext.Issuer</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseContext_EndpointType">OpenIddictServerEvents.BaseContext.EndpointType</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseContext_Logger">OpenIddictServerEvents.BaseContext.Logger</a>
</div>
<div>
<a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.BaseContext.html#OpenIddict_Server_OpenIddictServerEvents_BaseContext_Options">OpenIddictServerEvents.BaseContext.Options</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Server.html">OpenIddict.Server</a></h6>
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
<h5 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ApplyAuthorizationResponseContext : OpenIddictServerEvents.BaseRequestContext</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext__ctor_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.#ctor*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext__ctor_OpenIddict_Server_OpenIddictServerTransaction_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.#ctor(OpenIddict.Server.OpenIddictServerTransaction)">ApplyAuthorizationResponseContext(OpenIddictServerTransaction)</h4>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.html">OpenIddictServerEvents.ApplyAuthorizationResponseContext</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ApplyAuthorizationResponseContext(OpenIddictServerTransaction transaction)</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><a class="xref" href="OpenIddict.Server.OpenIddictServerTransaction.html">OpenIddictServerTransaction</a></td>
<td><span class="parametername">transaction</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_AccessToken_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.AccessToken*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_AccessToken" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.AccessToken">AccessToken</h4>
<div class="markdown level1 summary"><p>Gets the access code expected to
be returned to the client application.
Depending on the flow, it may be null.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AccessToken { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_AuthorizationCode_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.AuthorizationCode*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_AuthorizationCode" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.AuthorizationCode">AuthorizationCode</h4>
<div class="markdown level1 summary"><p>Gets the authorization code expected to
be returned to the client application.
Depending on the flow, it may be null.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AuthorizationCode { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Error_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Error*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Error" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Error">Error</h4>
<div class="markdown level1 summary"><p>Gets the error code returned to the client application.
When the response indicates a successful response,
this property returns <code>null</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Error { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Principal_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Principal*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Principal" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Principal">Principal</h4>
<div class="markdown level1 summary"><p>Gets or sets the security principal.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ClaimsPrincipal? Principal { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">ClaimsPrincipal</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_RedirectUri_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.RedirectUri*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_RedirectUri" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.RedirectUri">RedirectUri</h4>
<div class="markdown level1 summary"><p>Gets or sets the callback URL the user agent will be redirected to, if applicable.
Note: manually changing the value of this property is generally not recommended
and extreme caution must be taken to ensure the user agent is not redirected to
an untrusted address, which would result in an &quot;open redirection&quot; vulnerability.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string RedirectUri { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Request_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Request*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Request" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Request">Request</h4>
<div class="markdown level1 summary"><p>Gets or sets the request, or <code>null</code> if it couldn&apos;t be extracted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OpenIddictRequest? Request { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">OpenIddictRequest</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Response_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Response*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_Response" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.Response">Response</h4>
<div class="markdown level1 summary"><p>Gets or sets the response.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OpenIddictResponse Response { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">OpenIddictResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_ResponseMode_" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.ResponseMode*"></a>
<h4 id="OpenIddict_Server_OpenIddictServerEvents_ApplyAuthorizationResponseContext_ResponseMode" data-uid="OpenIddict.Server.OpenIddictServerEvents.ApplyAuthorizationResponseContext.ResponseMode">ResponseMode</h4>
<div class="markdown level1 summary"><p>Gets or sets the response mode used to redirect the user agent, if applicable.
Note: manually changing the value of this property is generally not recommended.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ResponseMode { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>