openiddict-documentation/guide/index.html
2020-07-03 21:51:56 +00:00

125 lines
6.0 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>Introduction </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Introduction ">
<meta name="generator" content="docfx 2.45.1.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" 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="../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="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="">
<h1 id="introduction">Introduction</h1>
<h2 id="whats-openiddict">What&#39;s OpenIddict?</h2>
<p>OpenIddict aims at providing a <strong>simple and easy-to-use solution</strong> to implement an <strong>OpenID Connect server in any ASP.NET Core 1.x or 2.x application</strong>.</p>
<p>OpenIddict is based on
<strong><a href="https://github.com/aspnet-contrib/AspNet.Security.OpenIdConnect.Server">AspNet.Security.OpenIdConnect.Server (codenamed ASOS)</a></strong> to control the OpenID Connect authentication flow and can be used with any membership stack, <strong>including <a href="https://github.com/aspnet/AspNetCore/tree/master/src/Identity">ASP.NET Core Identity</a></strong>.</p>
<p>OpenIddict fully supports the <strong><a href="http://openid.net/specs/openid-connect-core-1_0.html">code/implicit/hybrid flows</a></strong> and the <strong><a href="https://tools.ietf.org/html/rfc6749">client credentials/resource owner password grants</a></strong>. You can also create your own custom grant types.</p>
<p>Note: OpenIddict natively supports <strong><a href="https://github.com/aspnet/EntityFramework">Entity Framework Core</a></strong> and <strong><a href="https://github.com/aspnet/EntityFramework6">Entity Framework 6</a></strong> out-of-the-box, but you can also provide your own stores.</p>
<blockquote><p>Note: <strong>the OpenIddict 2.x packages are only compatible with ASP.NET Core 2.x</strong>.
If your application targets ASP.NET Core 1.x, use the OpenIddict 1.x packages.</p>
</blockquote>
<h2 id="why-an-openid-connect-server">Why an OpenID Connect server?</h2>
<p>Adding an OpenID Connect server to your application <strong>allows you to support token authentication</strong>.
It also allows you to manage all your users using local password or an external identity provider
(e.g. Facebook or Google) for all your applications in one central place,
with the power to control who can access your API and the information that is exposed to each client.</p>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/openiddict/openiddict-documentation/blob/dev/guide/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</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>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>