mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 18:04:57 +08:00
4460 lines
171 KiB
HTML
4460 lines
171 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 OpenIddictExtensions
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictExtensions
|
|
">
|
|
<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.OpenIddictExtensions">
|
|
|
|
|
|
<h1 id="OpenIddict_Abstractions_OpenIddictExtensions" data-uid="OpenIddict.Abstractions.OpenIddictExtensions" class="text-break">Class OpenIddictExtensions
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides extension methods to make <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>
|
|
and <a class="xref" href="OpenIddict.Abstractions.OpenIddictResponse.html">OpenIddictResponse</a> easier to work with.</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">OpenIddictExtensions</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_OpenIddictExtensions_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class OpenIddictExtensions</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_ClaimsIdentity_System_String_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim(ClaimsIdentity,System.String,System.String)">AddClaim(ClaimsIdentity, String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Adds a claim to a given identity.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity AddClaim(this ClaimsIdentity identity, string type, string value)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value associated with the claim.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_ClaimsIdentity_System_String_System_String_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim(ClaimsIdentity,System.String,System.String,ImmutableArray{System.String})">AddClaim(ClaimsIdentity, String, String, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Adds a claim to a given identity and specify one or more destinations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity AddClaim(this ClaimsIdentity identity, string type, string value, ImmutableArray<string> destinations)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations associated with the claim.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_AddClaim_ClaimsIdentity_System_String_System_String_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.AddClaim(ClaimsIdentity,System.String,System.String,System.String[])">AddClaim(ClaimsIdentity, String, String, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Adds a claim to a given identity and specify one or more destinations.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity AddClaim(this ClaimsIdentity identity, string type, string value, params string[] destinations)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations associated with the claim.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_Clone_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.Clone*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_Clone_ClaimsIdentity_System_Func_Claim_System_Boolean__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.Clone(ClaimsIdentity,System.Func{Claim,System.Boolean})">Clone(ClaimsIdentity, Func<Claim, Boolean>)</h4>
|
|
<div class="markdown level1 summary"><p>Clones an identity by filtering its claims and the claims of its actor, recursively.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity Clone(this ClaimsIdentity identity, Func<Claim, bool> filter)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The <see cref="!:ClaimsIdentity"></see> instance to filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Func</span><<span class="xref">Claim</span>, <span class="xref">System.Boolean</span>></td>
|
|
<td><span class="parametername">filter</span></td>
|
|
<td><p>The delegate filtering the claims: return <code>true</code>
|
|
to accept the claim, <code>false</code> to remove it.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_Clone_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.Clone*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_Clone_ClaimsPrincipal_System_Func_Claim_System_Boolean__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.Clone(ClaimsPrincipal,System.Func{Claim,System.Boolean})">Clone(ClaimsPrincipal, Func<Claim, Boolean>)</h4>
|
|
<div class="markdown level1 summary"><p>Clones a principal by filtering its identities.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal Clone(this ClaimsPrincipal principal, Func<Claim, bool> filter)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The <see cref="!:ClaimsPrincipal"></see> instance to filter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Func</span><<span class="xref">Claim</span>, <span class="xref">System.Boolean</span>></td>
|
|
<td><span class="parametername">filter</span></td>
|
|
<td><p>The delegate filtering the claims: return <code>true</code>
|
|
to accept the claim, <code>false</code> to remove it.</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetAccessTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAccessTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetAccessTokenLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAccessTokenLifetime(ClaimsPrincipal)">GetAccessTokenLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the access token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetAccessTokenLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The access token lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetAcrValues_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAcrValues*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetAcrValues_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAcrValues(OpenIddict.Abstractions.OpenIddictRequest)">GetAcrValues(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Extracts the authentication context class values from an <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetAcrValues(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetAudiences_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAudiences*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetAudiences_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAudiences(ClaimsPrincipal)">GetAudiences(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the audiences list stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetAudiences(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The audiences list or an empty set if the claims cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetAuthorizationCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAuthorizationCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetAuthorizationCodeLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAuthorizationCodeLifetime(ClaimsPrincipal)">GetAuthorizationCodeLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the authorization code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetAuthorizationCodeLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The authorization code lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetAuthorizationId_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAuthorizationId*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetAuthorizationId_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetAuthorizationId(ClaimsPrincipal)">GetAuthorizationId(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the internal authorization identifier associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetAuthorizationId(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.String</span></td>
|
|
<td><p>The unique identifier or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaim_ClaimsIdentity_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaim(ClaimsIdentity,System.String)">GetClaim(ClaimsIdentity, String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the claim value corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetClaim(this ClaimsIdentity identity, string type)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claim.</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><span class="xref">System.String</span></td>
|
|
<td><p>The claim value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaim_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaim(ClaimsPrincipal,System.String)">GetClaim(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the claim value corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetClaim(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claim.</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><span class="xref">System.String</span></td>
|
|
<td><p>The claim value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaims_ClaimsIdentity_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaims(ClaimsIdentity,System.String)">GetClaims(ClaimsIdentity, String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the claim values corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetClaims(this ClaimsIdentity identity, string type)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The claim values.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetClaims_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetClaims(ClaimsPrincipal,System.String)">GetClaims(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the claim values corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetClaims(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The claim values.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetCreationDate_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetCreationDate*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetCreationDate_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetCreationDate(ClaimsPrincipal)">GetCreationDate(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the creation date stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static DateTimeOffset? GetCreationDate(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
|
<td><p>The creation date or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetDestinations_Claim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDestinations(Claim)">GetDestinations(Claim)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the destinations associated with a claim.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetDestinations(this Claim claim)</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">Claim</span></td>
|
|
<td><span class="parametername">claim</span></td>
|
|
<td><p>The <see cref="!:Claim"></see> instance.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The destinations associated with the claim.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetDestinations_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDestinations(ClaimsPrincipal)">GetDestinations(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the destinations associated with all the claims of the given principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableDictionary<string, string[]> GetDestinations(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</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><span class="xref">ImmutableDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>[]></td>
|
|
<td><p>The destinations, returned as a flattened dictionary.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetDeviceCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDeviceCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetDeviceCodeLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetDeviceCodeLifetime(ClaimsPrincipal)">GetDeviceCodeLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the device code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetDeviceCodeLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The device code lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetExpirationDate_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetExpirationDate*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetExpirationDate_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetExpirationDate(ClaimsPrincipal)">GetExpirationDate(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the expiration date stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static DateTimeOffset? GetExpirationDate(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
|
<td><p>The expiration date or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetIdentityTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetIdentityTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetIdentityTokenLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetIdentityTokenLifetime(ClaimsPrincipal)">GetIdentityTokenLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the identity token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetIdentityTokenLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The identity token lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetPresenters_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetPresenters*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetPresenters_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetPresenters(ClaimsPrincipal)">GetPresenters(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the presenters list stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetPresenters(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The presenters list or an empty set if the claims cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetPrompts_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetPrompts*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetPrompts_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetPrompts(OpenIddict.Abstractions.OpenIddictRequest)">GetPrompts(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Extracts the prompt values from an <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetPrompts(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetRefreshTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetRefreshTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetRefreshTokenLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetRefreshTokenLifetime(ClaimsPrincipal)">GetRefreshTokenLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the refresh token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetRefreshTokenLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The refresh token lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetResources_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetResources*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetResources_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetResources(ClaimsPrincipal)">GetResources(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the resources list stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetResources(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The resources list or an empty set if the claims cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetResponseTypes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetResponseTypes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetResponseTypes_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetResponseTypes(OpenIddict.Abstractions.OpenIddictRequest)">GetResponseTypes(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Extracts the response types from an <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetResponseTypes(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetScopes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetScopes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetScopes_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetScopes(ClaimsPrincipal)">GetScopes(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the scopes list stored in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetScopes(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><p>The scopes list or an empty set if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetScopes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetScopes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetScopes_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetScopes(OpenIddict.Abstractions.OpenIddictRequest)">GetScopes(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Extracts the scopes from an <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImmutableArray<string> GetScopes(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetTokenId_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetTokenId*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetTokenId_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetTokenId(ClaimsPrincipal)">GetTokenId(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the internal token identifier associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetTokenId(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.String</span></td>
|
|
<td><p>The unique identifier or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetTokenType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetTokenType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetTokenType_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetTokenType(ClaimsPrincipal)">GetTokenType(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the token type associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static string GetTokenType(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.String</span></td>
|
|
<td><p>The token type or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_GetUserCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetUserCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_GetUserCodeLifetime_ClaimsPrincipal_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.GetUserCodeLifetime(ClaimsPrincipal)">GetUserCodeLifetime(ClaimsPrincipal)</h4>
|
|
<div class="markdown level1 summary"><p>Gets the user code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static TimeSpan? GetUserCodeLifetime(this ClaimsPrincipal principal)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</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><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><p>The user code lifetime or <code>null</code> if the claim cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasAcrValue_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasAcrValue*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasAcrValue_OpenIddict_Abstractions_OpenIddictRequest_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasAcrValue(OpenIddict.Abstractions.OpenIddictRequest,System.String)">HasAcrValue(OpenIddictRequest, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the requested authentication context class values contain the specified item.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasAcrValue(this OpenIddictRequest request, string value)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The component to look for in the parameter.</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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasAudience_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasAudience*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasAudience_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasAudience(ClaimsPrincipal,System.String)">HasAudience(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims principal contains the given audience.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasAudience(this ClaimsPrincipal principal, string audience)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">audience</span></td>
|
|
<td><p>The audience.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the principal contains the given audience.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasClaim_ClaimsIdentity_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasClaim(ClaimsIdentity,System.String)">HasClaim(ClaimsIdentity, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims identity contains at least one claim of the specified type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasClaim(this ClaimsIdentity identity, string type)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The claim type.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the identity contains at least one claim of the specified type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasClaim_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasClaim(ClaimsPrincipal,System.String)">HasClaim(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims principal contains at least one claim of the specified type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasClaim(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The claim type.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the principal contains at least one claim of the specified type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasDestination_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasDestination*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasDestination_Claim_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasDestination(Claim,System.String)">HasDestination(Claim, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the given claim contains the required destination.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasDestination(this Claim claim, string destination)</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">Claim</span></td>
|
|
<td><span class="parametername">claim</span></td>
|
|
<td><p>The <see cref="!:Claim"></see> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">destination</span></td>
|
|
<td><p>The required destination.</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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasPresenter_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasPresenter*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasPresenter_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasPresenter(ClaimsPrincipal,System.String)">HasPresenter(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims principal contains the given presenter.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasPresenter(this ClaimsPrincipal principal, string presenter)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">presenter</span></td>
|
|
<td><p>The presenter.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the principal contains the given presenter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasPrompt_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasPrompt*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasPrompt_OpenIddict_Abstractions_OpenIddictRequest_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasPrompt(OpenIddict.Abstractions.OpenIddictRequest,System.String)">HasPrompt(OpenIddictRequest, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the requested prompt contains the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasPrompt(this OpenIddictRequest request, string prompt)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">prompt</span></td>
|
|
<td><p>The component to look for in the parameter.</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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasResource_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasResource*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasResource_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasResource(ClaimsPrincipal,System.String)">HasResource(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims principal contains the given resource.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasResource(this ClaimsPrincipal principal, string resource)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">resource</span></td>
|
|
<td><p>The resource.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the principal contains the given resource.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasResponseType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasResponseType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasResponseType_OpenIddict_Abstractions_OpenIddictRequest_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasResponseType(OpenIddict.Abstractions.OpenIddictRequest,System.String)">HasResponseType(OpenIddictRequest, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the requested response type contains the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasResponseType(this OpenIddictRequest request, string type)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The component to look for in the parameter.</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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasScope_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasScope*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasScope_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasScope(ClaimsPrincipal,System.String)">HasScope(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the claims principal contains the given scope.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasScope(this ClaimsPrincipal principal, string scope)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">scope</span></td>
|
|
<td><p>The scope.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the principal contains the given scope.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasScope_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasScope*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasScope_OpenIddict_Abstractions_OpenIddictRequest_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasScope(OpenIddict.Abstractions.OpenIddictRequest,System.String)">HasScope(OpenIddictRequest, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the requested scope contains the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasScope(this OpenIddictRequest request, string scope)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">scope</span></td>
|
|
<td><p>The component to look for in the parameter.</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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_HasTokenType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasTokenType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_HasTokenType_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.HasTokenType(ClaimsPrincipal,System.String)">HasTokenType(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the token type associated with the claims principal matches the specified type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool HasTokenType(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The token type.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the token type matches the specified type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsAuthorizationCodeFlow_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsAuthorizationCodeFlow*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsAuthorizationCodeFlow_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsAuthorizationCodeFlow(OpenIddict.Abstractions.OpenIddictRequest)">IsAuthorizationCodeFlow(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_type" parameter corresponds to the authorization code flow.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.1.1">http://tools.ietf.org/html/rfc6749#section-4.1.1</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsAuthorizationCodeFlow(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a code flow request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsAuthorizationCodeGrantType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsAuthorizationCodeGrantType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsAuthorizationCodeGrantType_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsAuthorizationCodeGrantType(OpenIddict.Abstractions.OpenIddictRequest)">IsAuthorizationCodeGrantType(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "grant_type" parameter corresponds to the authorization code grant.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.1.3">http://tools.ietf.org/html/rfc6749#section-4.1.3</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsAuthorizationCodeGrantType(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a code grant request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsClientCredentialsGrantType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsClientCredentialsGrantType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsClientCredentialsGrantType_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsClientCredentialsGrantType(OpenIddict.Abstractions.OpenIddictRequest)">IsClientCredentialsGrantType(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "grant_type" parameter corresponds to the client credentials grant.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.4.2">http://tools.ietf.org/html/rfc6749#section-4.4.2</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsClientCredentialsGrantType(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a client credentials grant request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsDeviceCodeGrantType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsDeviceCodeGrantType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsDeviceCodeGrantType_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsDeviceCodeGrantType(OpenIddict.Abstractions.OpenIddictRequest)">IsDeviceCodeGrantType(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "grant_type" parameter corresponds to the device code grant.
|
|
See <a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsDeviceCodeGrantType(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a device code grant request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsFormPostResponseMode_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsFormPostResponseMode*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsFormPostResponseMode_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsFormPostResponseMode(OpenIddict.Abstractions.OpenIddictRequest)">IsFormPostResponseMode(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_mode" parameter corresponds to the form post response mode.
|
|
See <a href="http://openid.net/specs/oauth-v2-form-post-response-mode-1_0.html">http://openid.net/specs/oauth-v2-form-post-response-mode-1_0.html</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsFormPostResponseMode(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request specified the form post response mode or if
|
|
it's the default value for the requested flow, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsFragmentResponseMode_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsFragmentResponseMode*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsFragmentResponseMode_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsFragmentResponseMode(OpenIddict.Abstractions.OpenIddictRequest)">IsFragmentResponseMode(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_mode" parameter corresponds to the fragment response mode.
|
|
See <a href="http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html">http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsFragmentResponseMode(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request specified the fragment response mode or if
|
|
it's the default value for the requested flow, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsHybridFlow_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsHybridFlow*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsHybridFlow_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsHybridFlow(OpenIddict.Abstractions.OpenIddictRequest)">IsHybridFlow(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_type" parameter corresponds to the hybrid flow.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.2.1">http://tools.ietf.org/html/rfc6749#section-4.2.1</a> and
|
|
<a href="http://openid.net/specs/openid-connect-core-1_0.html">http://openid.net/specs/openid-connect-core-1_0.html</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsHybridFlow(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is an hybrid flow request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsImplicitFlow_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsImplicitFlow*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsImplicitFlow_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsImplicitFlow(OpenIddict.Abstractions.OpenIddictRequest)">IsImplicitFlow(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_type" parameter corresponds to the implicit flow.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.2.1">http://tools.ietf.org/html/rfc6749#section-4.2.1</a> and
|
|
<a href="http://openid.net/specs/openid-connect-core-1_0.html">http://openid.net/specs/openid-connect-core-1_0.html</a> for more information</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsImplicitFlow(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is an implicit flow request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsNoneFlow_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsNoneFlow*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsNoneFlow_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsNoneFlow(OpenIddict.Abstractions.OpenIddictRequest)">IsNoneFlow(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_type" parameter corresponds to the "none" response type.
|
|
See <a href="http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#none">http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html#none</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsNoneFlow(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a response_type=none request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsPasswordGrantType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsPasswordGrantType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsPasswordGrantType_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsPasswordGrantType(OpenIddict.Abstractions.OpenIddictRequest)">IsPasswordGrantType(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "grant_type" parameter corresponds to the password grant.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-4.3.2">http://tools.ietf.org/html/rfc6749#section-4.3.2</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsPasswordGrantType(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a password grant request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsQueryResponseMode_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsQueryResponseMode*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsQueryResponseMode_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsQueryResponseMode(OpenIddict.Abstractions.OpenIddictRequest)">IsQueryResponseMode(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "response_mode" parameter corresponds to the query response mode.
|
|
See <a href="http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html">http://openid.net/specs/oauth-v2-multiple-response-types-1_0.html</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsQueryResponseMode(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request specified the query response mode or if
|
|
it's the default value for the requested flow, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_IsRefreshTokenGrantType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsRefreshTokenGrantType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_IsRefreshTokenGrantType_OpenIddict_Abstractions_OpenIddictRequest_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.IsRefreshTokenGrantType(OpenIddict.Abstractions.OpenIddictRequest)">IsRefreshTokenGrantType(OpenIddictRequest)</h4>
|
|
<div class="markdown level1 summary"><p>Determines whether the "grant_type" parameter corresponds to the refresh token grant.
|
|
See <a href="http://tools.ietf.org/html/rfc6749#section-6">http://tools.ietf.org/html/rfc6749#section-6</a> for more information.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsRefreshTokenGrantType(this OpenIddictRequest request)</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.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The <a class="xref" href="OpenIddict.Abstractions.OpenIddictRequest.html">OpenIddictRequest</a> instance.</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><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if the request is a refresh token grant request, <code>false</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_RemoveClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.RemoveClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_RemoveClaims_ClaimsIdentity_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.RemoveClaims(ClaimsIdentity,System.String)">RemoveClaims(ClaimsIdentity, String)</h4>
|
|
<div class="markdown level1 summary"><p>Removes all the claims corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity RemoveClaims(this ClaimsIdentity identity, string type)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_RemoveClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.RemoveClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_RemoveClaims_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.RemoveClaims(ClaimsPrincipal,System.String)">RemoveClaims(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Removes all the claims corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal RemoveClaims(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAccessTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAccessTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAccessTokenLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAccessTokenLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetAccessTokenLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the access token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAccessTokenLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The access token lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_ClaimsPrincipal_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences(ClaimsPrincipal,ImmutableArray{System.String})">SetAudiences(ClaimsPrincipal, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the audiences list in the claims principal.
|
|
Note: this method automatically excludes duplicate audiences.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAudiences(this ClaimsPrincipal principal, ImmutableArray<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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">audiences</span></td>
|
|
<td><p>The audiences to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_ClaimsPrincipal_System_Collections_Generic_IEnumerable_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences(ClaimsPrincipal,System.Collections.Generic.IEnumerable{System.String})">SetAudiences(ClaimsPrincipal, IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the audiences list in the claims principal.
|
|
Note: this method automatically excludes duplicate audiences.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAudiences(this ClaimsPrincipal principal, IEnumerable<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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">audiences</span></td>
|
|
<td><p>The audiences to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAudiences_ClaimsPrincipal_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAudiences(ClaimsPrincipal,System.String[])">SetAudiences(ClaimsPrincipal, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Sets the audiences list in the claims principal.
|
|
Note: this method automatically excludes duplicate audiences.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAudiences(this ClaimsPrincipal principal, 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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">audiences</span></td>
|
|
<td><p>The audiences to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAuthorizationCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAuthorizationCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAuthorizationCodeLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAuthorizationCodeLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetAuthorizationCodeLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the authorization code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAuthorizationCodeLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The authorization code lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetAuthorizationId_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAuthorizationId*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetAuthorizationId_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetAuthorizationId(ClaimsPrincipal,System.String)">SetAuthorizationId(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the internal authorization identifier associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetAuthorizationId(this ClaimsPrincipal principal, 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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">identifier</span></td>
|
|
<td><p>The unique identifier to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaim_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaim*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaim_ClaimsPrincipal_System_String_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaim(ClaimsPrincipal,System.String,System.String)">SetClaim(ClaimsPrincipal, String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the claim value corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetClaim(this ClaimsPrincipal principal, string type, string value)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The claim value.</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_ClaimsIdentity_System_String_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims(ClaimsIdentity,System.String,ImmutableArray{System.String})">SetClaims(ClaimsIdentity, String, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the claim values corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity SetClaims(this ClaimsIdentity identity, string type, ImmutableArray<string> values)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>The claim values.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_ClaimsIdentity_System_String_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims(ClaimsIdentity,System.String,System.String)">SetClaims(ClaimsIdentity, String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the claim value corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsIdentity SetClaims(this ClaimsIdentity identity, string type, string value)</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">ClaimsIdentity</span></td>
|
|
<td><span class="parametername">identity</span></td>
|
|
<td><p>The identity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The claim value.</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><span class="xref">ClaimsIdentity</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetClaims_ClaimsPrincipal_System_String_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetClaims(ClaimsPrincipal,System.String,ImmutableArray{System.String})">SetClaims(ClaimsPrincipal, String, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the claim values corresponding to the given type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetClaims(this ClaimsPrincipal principal, string type, ImmutableArray<string> values)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type associated with the claims.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">values</span></td>
|
|
<td><p>The claim values.</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims identity.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetCreationDate_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetCreationDate*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetCreationDate_ClaimsPrincipal_System_Nullable_System_DateTimeOffset__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetCreationDate(ClaimsPrincipal,System.Nullable{System.DateTimeOffset})">SetCreationDate(ClaimsPrincipal, Nullable<DateTimeOffset>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the creation date in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetCreationDate(this ClaimsPrincipal principal, DateTimeOffset? date)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
|
<td><span class="parametername">date</span></td>
|
|
<td><p>The creation date</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_Claim_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations(Claim,ImmutableArray{System.String})">SetDestinations(Claim, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Adds specific destinations to a claim.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Claim SetDestinations(this Claim claim, ImmutableArray<string> destinations)</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">Claim</span></td>
|
|
<td><span class="parametername">claim</span></td>
|
|
<td><p>The <see cref="!:Claim"></see> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations.</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><span class="xref">Claim</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_Claim_System_Collections_Generic_IEnumerable_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations(Claim,System.Collections.Generic.IEnumerable{System.String})">SetDestinations(Claim, IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Adds specific destinations to a claim.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Claim SetDestinations(this Claim claim, IEnumerable<string> destinations)</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">Claim</span></td>
|
|
<td><span class="parametername">claim</span></td>
|
|
<td><p>The <see cref="!:Claim"></see> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations.</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><span class="xref">Claim</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_Claim_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations(Claim,System.String[])">SetDestinations(Claim, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Adds specific destinations to a claim.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Claim SetDestinations(this Claim claim, params string[] destinations)</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">Claim</span></td>
|
|
<td><span class="parametername">claim</span></td>
|
|
<td><p>The <see cref="!:Claim"></see> instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations.</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><span class="xref">Claim</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetDestinations_ClaimsPrincipal_ImmutableDictionary_System_String_System_String____" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDestinations(ClaimsPrincipal,ImmutableDictionary{System.String,System.String[]})">SetDestinations(ClaimsPrincipal, ImmutableDictionary<String, String[]>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the destinations associated with all the claims of the given principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetDestinations(this ClaimsPrincipal principal, ImmutableDictionary<string, string[]> destinations)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>[]></td>
|
|
<td><span class="parametername">destinations</span></td>
|
|
<td><p>The destinations, as a flattened dictionary.</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetDeviceCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDeviceCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetDeviceCodeLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetDeviceCodeLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetDeviceCodeLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the device code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetDeviceCodeLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The device code lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetExpirationDate_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetExpirationDate*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetExpirationDate_ClaimsPrincipal_System_Nullable_System_DateTimeOffset__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetExpirationDate(ClaimsPrincipal,System.Nullable{System.DateTimeOffset})">SetExpirationDate(ClaimsPrincipal, Nullable<DateTimeOffset>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the expiration date in the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetExpirationDate(this ClaimsPrincipal principal, DateTimeOffset? date)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
|
<td><span class="parametername">date</span></td>
|
|
<td><p>The expiration date</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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetIdentityTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetIdentityTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetIdentityTokenLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetIdentityTokenLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetIdentityTokenLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the identity token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetIdentityTokenLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The identity token lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_ClaimsPrincipal_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters(ClaimsPrincipal,ImmutableArray{System.String})">SetPresenters(ClaimsPrincipal, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the presenters list in the claims principal.
|
|
Note: this method automatically excludes duplicate presenters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetPresenters(this ClaimsPrincipal principal, ImmutableArray<string> presenters)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">presenters</span></td>
|
|
<td><p>The presenters to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_ClaimsPrincipal_System_Collections_Generic_IEnumerable_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters(ClaimsPrincipal,System.Collections.Generic.IEnumerable{System.String})">SetPresenters(ClaimsPrincipal, IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the presenters list in the claims principal.
|
|
Note: this method automatically excludes duplicate presenters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetPresenters(this ClaimsPrincipal principal, IEnumerable<string> presenters)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">presenters</span></td>
|
|
<td><p>The presenters to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetPresenters_ClaimsPrincipal_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetPresenters(ClaimsPrincipal,System.String[])">SetPresenters(ClaimsPrincipal, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Sets the presenters list in the claims principal.
|
|
Note: this method automatically excludes duplicate presenters.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetPresenters(this ClaimsPrincipal principal, params string[] presenters)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">presenters</span></td>
|
|
<td><p>The presenters to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetRefreshTokenLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetRefreshTokenLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetRefreshTokenLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetRefreshTokenLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetRefreshTokenLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the refresh token lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetRefreshTokenLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The refresh token lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_ClaimsPrincipal_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources(ClaimsPrincipal,ImmutableArray{System.String})">SetResources(ClaimsPrincipal, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the resources list in the claims principal.
|
|
Note: this method automatically excludes duplicate resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetResources(this ClaimsPrincipal principal, ImmutableArray<string> resources)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">resources</span></td>
|
|
<td><p>The resources to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_ClaimsPrincipal_System_Collections_Generic_IEnumerable_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources(ClaimsPrincipal,System.Collections.Generic.IEnumerable{System.String})">SetResources(ClaimsPrincipal, IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the resources list in the claims principal.
|
|
Note: this method automatically excludes duplicate resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetResources(this ClaimsPrincipal principal, IEnumerable<string> resources)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">resources</span></td>
|
|
<td><p>The resources to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetResources_ClaimsPrincipal_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetResources(ClaimsPrincipal,System.String[])">SetResources(ClaimsPrincipal, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Sets the resources list in the claims principal.
|
|
Note: this method automatically excludes duplicate resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetResources(this ClaimsPrincipal principal, params string[] resources)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">resources</span></td>
|
|
<td><p>The resources to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_ClaimsPrincipal_ImmutableArray_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes(ClaimsPrincipal,ImmutableArray{System.String})">SetScopes(ClaimsPrincipal, ImmutableArray<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the scopes list in the claims principal.
|
|
Note: this method automatically excludes duplicate scopes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetScopes(this ClaimsPrincipal principal, ImmutableArray<string> scopes)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ImmutableArray</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">scopes</span></td>
|
|
<td><p>The scopes to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_ClaimsPrincipal_System_Collections_Generic_IEnumerable_System_String__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes(ClaimsPrincipal,System.Collections.Generic.IEnumerable{System.String})">SetScopes(ClaimsPrincipal, IEnumerable<String>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the scopes list in the claims principal.
|
|
Note: this method automatically excludes duplicate scopes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetScopes(this ClaimsPrincipal principal, IEnumerable<string> scopes)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
|
<td><span class="parametername">scopes</span></td>
|
|
<td><p>The scopes to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetScopes_ClaimsPrincipal_System_String___" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetScopes(ClaimsPrincipal,System.String[])">SetScopes(ClaimsPrincipal, String[])</h4>
|
|
<div class="markdown level1 summary"><p>Sets the scopes list in the claims principal.
|
|
Note: this method automatically excludes duplicate scopes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetScopes(this ClaimsPrincipal principal, params string[] scopes)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span>[]</td>
|
|
<td><span class="parametername">scopes</span></td>
|
|
<td><p>The scopes to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetTokenId_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetTokenId*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetTokenId_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetTokenId(ClaimsPrincipal,System.String)">SetTokenId(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the internal token identifier associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetTokenId(this ClaimsPrincipal principal, 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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">identifier</span></td>
|
|
<td><p>The unique identifier to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetTokenType_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetTokenType*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetTokenType_ClaimsPrincipal_System_String_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetTokenType(ClaimsPrincipal,System.String)">SetTokenType(ClaimsPrincipal, String)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the token type associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetTokenType(this ClaimsPrincipal principal, string type)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The token type to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Abstractions_OpenIddictExtensions_SetUserCodeLifetime_" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetUserCodeLifetime*"></a>
|
|
<h4 id="OpenIddict_Abstractions_OpenIddictExtensions_SetUserCodeLifetime_ClaimsPrincipal_System_Nullable_System_TimeSpan__" data-uid="OpenIddict.Abstractions.OpenIddictExtensions.SetUserCodeLifetime(ClaimsPrincipal,System.Nullable{System.TimeSpan})">SetUserCodeLifetime(ClaimsPrincipal, Nullable<TimeSpan>)</h4>
|
|
<div class="markdown level1 summary"><p>Sets the user code lifetime associated with the claims principal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ClaimsPrincipal SetUserCodeLifetime(this ClaimsPrincipal principal, TimeSpan? lifetime)</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">ClaimsPrincipal</span></td>
|
|
<td><span class="parametername">principal</span></td>
|
|
<td><p>The claims principal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.TimeSpan</span>></td>
|
|
<td><span class="parametername">lifetime</span></td>
|
|
<td><p>The user code lifetime to 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><span class="xref">ClaimsPrincipal</span></td>
|
|
<td><p>The claims principal.</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>
|