lsm/openiddict-documentation
1
0
Fork 0
mirror of https://gitee.com/dcren/openiddict-documentation.git synced 2025-09-19 18:19:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the documentation pages

Browse Source
This commit is contained in:
OpenIddict Bot
2020-07-03 21:51:56 +00:00
parent f4f15466c4
commit cf7d02d6d9
20 changed files with 870 additions and 792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
configuration/application-permissions.html
View File

@@ -8,7 +8,7 @@
<title>Application permissions </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Application permissions ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -146,9 +146,9 @@ token endpoints but will get an error when trying to send an introspection or re
options.IgnoreEndpointPermissions();
});
</code></pre><h2 id="grant-type-permissions">Grant type permissions</h2>
<h3 id="definition">Definition</h3>
<h3 id="definition-1">Definition</h3>
<p>Grant type permissions limit the flows a client application is allowed to use.</p>
<h3 id="supported-permissions">Supported permissions</h3>
<h3 id="supported-permissions-1">Supported permissions</h3>
<table>
<thead>
<tr>
@@ -181,7 +181,7 @@ token endpoints but will get an error when trying to send an introspection or re
</table>
<p>To add a custom flow permission, you can use the following pattern:</p>
<pre><code class="lang-csharp">OpenIddictConstants.Permissions.Prefixes.GrantType + &quot;custom_flow_name&quot;
</code></pre><h3 id="example">Example</h3>
</code></pre><h3 id="example-1">Example</h3>
<p>In the following example, the <code>postman</code> application can only use the authorization code flow
while <code>console</code> is restricted to the <code>password</code> and <code>refresh_token</code> flows:</p>
<pre><code class="lang-csharp">if (await manager.FindByClientIdAsync(&quot;postman&quot;) == null)
@@ -224,11 +224,11 @@ if (await manager.FindByClientIdAsync(&quot;console&quot;) == null)
options.IgnoreGrantTypePermissions();
});
</code></pre><h2 id="scope-permissions">Scope permissions</h2>
<h3 id="definition">Definition</h3>
<h3 id="definition-2">Definition</h3>
<p>Scope permissions limit the scopes (standard or custom) a client application is allowed to use.</p>
<blockquote><p>The <code>openid</code> and <code>offline_access</code> scopes are special-cased by OpenIddict and don&#39;t require explicit permissions.</p>
</blockquote>
<h3 id="supported-permissions">Supported permissions</h3>
<h3 id="supported-permissions-2">Supported permissions</h3>
<table>
<thead>
<tr>
@@ -261,7 +261,7 @@ if (await manager.FindByClientIdAsync(&quot;console&quot;) == null)
</table>
<p>To add a custom scope permission, you can use the following pattern:</p>
<pre><code class="lang-csharp">OpenIddictConstants.Permissions.Prefixes.Scope + &quot;custom_scope_name&quot;
</code></pre><h3 id="example">Example</h3>
</code></pre><h3 id="example-2">Example</h3>
<p>In the following sample, the <code>angular</code> client is allowed to request the <code>address</code>,
<code>profile</code> and <code>marketing_api</code> scopes: any other scope will result in an error being returned.</p>
<pre><code class="lang-csharp">if (await manager.FindByClientIdAsync(&quot;angular&quot;) == null)
@@ -317,7 +317,7 @@ if (await manager.FindByClientIdAsync(&quot;console&quot;) == null)
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

6
configuration/index.html
View File

@@ -8,7 +8,7 @@
<title>Configuration and settings </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Configuration and settings ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -114,7 +114,7 @@
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

121
configuration/toc.html
View File

@@ -1,65 +1,4 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Table of Content </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Table of Content ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<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="../logo.svg" 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="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">

<div id="sidetoggle">
<div>
<div class="sidefilter">
@@ -72,51 +11,17 @@
<div class="toc" id="toc">
<ul class="nav level1">
<li>
<a href="index.html" name="" title="Introduction">Introduction</a>
</li>
<li>
<a href="token-setup-and-validation.html" name="" title="Token setup and API validation">Token setup and API validation</a>
</li>
<li>
<a href="application-permissions.html" name="" title="Application permissions">Application permissions</a>
</li>
</ul> </div>
<li>
<a href="index.html" name="" title="Introduction">Introduction</a>
</li>
<li>
<a href="token-setup-and-validation.html" name="" title="Token setup and API validation">Token setup and API validation</a>
</li>
<li>
<a href="application-permissions.html" name="" title="Application permissions">Application permissions</a>
</li>
</ul>
</div>
</div>
</div>
</div></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">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>Copyright © 2015-2017 Microsoft<br>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>
</div>

22
configuration/token-setup-and-validation.html
View File

@@ -8,7 +8,7 @@
<title>Token setup and validation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Token setup and validation ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -111,7 +111,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
//...
}
</code></pre><h2 id="default-token-validation">Default token validation</h2>
<h3 id="authorization-server">Authorization server</h3>
<h3 id="authorization-server-1">Authorization server</h3>
<pre><code class="lang-csharp">// Startup.cs
public void ConfigureServices(IServiceCollection services)
@@ -209,7 +209,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
public class MyController : Controller
</code></pre><h1 id="reference-token-format">Reference token format</h1>
<h2 id="reference-token-generation">Reference token generation</h2>
<h3 id="authorization-server">Authorization server</h3>
<h3 id="authorization-server-2">Authorization server</h3>
<pre><code class="lang-c#">// Startup.cs
public void ConfigureServices(IServiceCollection services)
@@ -243,7 +243,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
//...
}
</code></pre><h2 id="reference-token-validation">Reference token validation</h2>
<h3 id="authorization-server">Authorization server</h3>
<h3 id="authorization-server-3">Authorization server</h3>
<pre><code class="lang-c#">// Startup.cs
public void ConfigureServices(IServiceCollection services)
@@ -306,7 +306,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
app.UseAuthentication();
//...
}
</code></pre><h3 id="api-controller">Api controller</h3>
</code></pre><h3 id="api-controller-1">Api controller</h3>
<pre><code class="lang-c#">// Note: both OpenIddictValidationDefaults.AuthenticationScheme and JwtBearerDefaults.AuthenticationScheme are &quot;Bearer&quot;
//If you did not set the default authentication scheme then specify it here.
//If you get a 302 redirect to login page instead of a 401 Unauthorized then Cookie authentication is handling the request
@@ -315,7 +315,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
public class MyController : Controller
</code></pre><h1 id="jwts">JWTs</h1>
<h2 id="jwt-generation">JWT generation</h2>
<h3 id="authorization-server">Authorization server</h3>
<h3 id="authorization-server-4">Authorization server</h3>
<pre><code class="lang-c#">// Startup.cs
public void ConfigureServices(IServiceCollection services)
@@ -352,7 +352,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
// &lt;EmbeddedResource Include=&quot;FolderName\certname.pfx&quot; /&gt;
// &lt;/ItemGroup&gt;
</code></pre><h2 id="jwt-validation">JWT validation</h2>
<h3 id="authorization-server">Authorization server</h3>
<h3 id="authorization-server-5">Authorization server</h3>
<div class="WARNING"><h5>Warning</h5><p>Remember, this is only needed if you have API endpoints that require token authorization. If your authorization server generates tokens that are only used by separate resource servers, then this is not needed.</p>
</div>
<pre><code class="lang-c#">// Startup.cs
@@ -385,7 +385,7 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
app.UseAuthentication();
//...
}
</code></pre><h3 id="resource-server">Resource server</h3>
</code></pre><h3 id="resource-server-1">Resource server</h3>
<pre><code class="lang-c#">// Startup.cs
public void ConfigureServices(IServiceCollection services)
@@ -408,7 +408,7 @@ public void ConfigureServices(IServiceCollection services)
};
});
}
</code></pre><h3 id="api-controller">Api controller</h3>
</code></pre><h3 id="api-controller-2">Api controller</h3>
<pre><code class="lang-c#">// Note: both OpenIddictValidationDefaults.AuthenticationScheme and JwtBearerDefaults.AuthenticationScheme are &quot;Bearer&quot;
//If you didn&#39;t set the default authentication scheme then specify it here.
//If you get a 302 redirect to login page instead of a 401 Unauthorized then Cookie authentication is handling the request
@@ -443,7 +443,7 @@ public class MyController : Controller
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>