openiddict-documentation/api/OpenIddict.Abstractions.OpenIddictTokenDescriptor.html
2021-02-08 10:58:19 +00:00

467 lines
18 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 OpenIddictTokenDescriptor
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OpenIddictTokenDescriptor
">
<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.Abstractions.OpenIddictTokenDescriptor">
<h1 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor" class="text-break">Class OpenIddictTokenDescriptor
</h1>
<div class="markdown level0 summary"><p>Represents an OpenIddict token descriptor.</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">OpenIddictTokenDescriptor</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Abstractions.html">OpenIddict.Abstractions</a></h6>
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
<h5 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class OpenIddictTokenDescriptor</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ApplicationId_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ApplicationId*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ApplicationId" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ApplicationId">ApplicationId</h4>
<div class="markdown level1 summary"><p>Gets or sets the application identifier associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ApplicationId { 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_Abstractions_OpenIddictTokenDescriptor_AuthorizationId_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.AuthorizationId*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_AuthorizationId" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.AuthorizationId">AuthorizationId</h4>
<div class="markdown level1 summary"><p>Gets or sets the authorization identifier associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AuthorizationId { 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_Abstractions_OpenIddictTokenDescriptor_CreationDate_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.CreationDate*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_CreationDate" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.CreationDate">CreationDate</h4>
<div class="markdown level1 summary"><p>Gets or sets the creation date associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DateTimeOffset? CreationDate { 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">DateTimeOffset</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ExpirationDate_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ExpirationDate*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ExpirationDate" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ExpirationDate">ExpirationDate</h4>
<div class="markdown level1 summary"><p>Gets or sets the expiration date associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DateTimeOffset? ExpirationDate { 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">DateTimeOffset</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Payload_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Payload*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Payload" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Payload">Payload</h4>
<div class="markdown level1 summary"><p>Gets or sets the payload associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Payload { 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_Abstractions_OpenIddictTokenDescriptor_Principal_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Principal*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Principal" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Principal">Principal</h4>
<div class="markdown level1 summary"><p>Gets or sets the optional principal associated with the token.
Note: this property is not stored by the default token stores.</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_Abstractions_OpenIddictTokenDescriptor_Properties_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Properties*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Properties" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Properties">Properties</h4>
<div class="markdown level1 summary"><p>Gets the additional properties associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Dictionary&lt;string, JsonElement&gt; Properties { 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">Dictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">JsonElement</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_RedemptionDate_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.RedemptionDate*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_RedemptionDate" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.RedemptionDate">RedemptionDate</h4>
<div class="markdown level1 summary"><p>Gets or sets the redemption date associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DateTimeOffset? RedemptionDate { 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">DateTimeOffset</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ReferenceId_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ReferenceId*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_ReferenceId" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.ReferenceId">ReferenceId</h4>
<div class="markdown level1 summary"><p>Gets or sets the reference identifier associated with the token.
Note: depending on the application manager used when creating it,
this property may be hashed or encrypted for security reasons.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ReferenceId { 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_Abstractions_OpenIddictTokenDescriptor_Status_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Status*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Status" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Status">Status</h4>
<div class="markdown level1 summary"><p>Gets or sets the status associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Status { 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_Abstractions_OpenIddictTokenDescriptor_Subject_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Subject*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Subject" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Subject">Subject</h4>
<div class="markdown level1 summary"><p>Gets or sets the subject associated with the token.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Subject { 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_Abstractions_OpenIddictTokenDescriptor_Type_" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Type*"></a>
<h4 id="OpenIddict_Abstractions_OpenIddictTokenDescriptor_Type" data-uid="OpenIddict.Abstractions.OpenIddictTokenDescriptor.Type">Type</h4>
<div class="markdown level1 summary"><p>Gets or sets the token type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Type { 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>