254 lines
8.7 KiB
HTML
254 lines
8.7 KiB
HTML
|
|
||
|
|
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<title>Welcome to Django OIDC Provider Documentation! — django-oidc-provider 0.2.5 documentation</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="top" title="django-oidc-provider 0.2.5 documentation" href="#"/>
|
||
|
|
<link rel="next" title="Installation" href="installation.html"/>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="wy-body-for-nav" role="document">
|
||
|
|
|
||
|
|
<div class="wy-grid-for-nav">
|
||
|
|
|
||
|
|
|
||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
|
|
<div class="wy-side-scroll">
|
||
|
|
<div class="wy-side-nav-search">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<a href="#" class="icon icon-home"> django-oidc-provider
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</a>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="version">
|
||
|
|
0.2
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="search">
|
||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="serverkeys.html">Server Keys</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="templates.html">Templates</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="claims.html">Standard Claims</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribute</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
|
|
||
|
|
|
||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
|
|
<a href="#">django-oidc-provider</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="wy-nav-content">
|
||
|
|
<div class="rst-content">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
<li><a href="#">Docs</a> »</li>
|
||
|
|
|
||
|
|
<li>Welcome to Django OIDC Provider Documentation!</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
|
||
|
|
|
||
|
|
<a href="_sources/index.txt" rel="nofollow"> View page source</a>
|
||
|
|
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<hr/>
|
||
|
|
</div>
|
||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
|
<div itemprop="articleBody">
|
||
|
|
|
||
|
|
<div class="section" id="welcome-to-django-oidc-provider-documentation">
|
||
|
|
<h1>Welcome to Django OIDC Provider Documentation!<a class="headerlink" href="#welcome-to-django-oidc-provider-documentation" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<p>Django OIDC Provider can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects.</p>
|
||
|
|
<p>Before getting started there are some important things that you should know:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>Although OpenID was built on top of OAuth2, this isn’t an OAuth2 server. Maybe in a future it will be.</li>
|
||
|
|
<li>Despite that implementation MUST support TLS. You can make request without using SSL. There is no control on that.</li>
|
||
|
|
<li>This cover <strong>Authorization Code Flow</strong> and <strong>Implicit Flow</strong>, NO support for <strong>Hybrid Flow</strong> at this moment.</li>
|
||
|
|
<li>Only support for requesting Claims using Scope Values.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Contents:</p>
|
||
|
|
<div class="toctree-wrapper compound">
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="installation.html#quick-installation">Quick Installation</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="serverkeys.html">Server Keys</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="templates.html">Templates</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="claims.html">Standard Claims</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#site-url">SITE_URL</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#login-url">LOGIN_URL</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-after-userlogin-hook">OIDC_AFTER_USERLOGIN_HOOK</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-code-expire">OIDC_CODE_EXPIRE</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-extra-scope-claims">OIDC_EXTRA_SCOPE_CLAIMS</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-idtoken-expire">OIDC_IDTOKEN_EXPIRE</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-idtoken-sub-generator">OIDC_IDTOKEN_SUB_GENERATOR</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-skip-consent-always">OIDC_SKIP_CONSENT_ALWAYS</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-skip-consent-enable">OIDC_SKIP_CONSENT_ENABLE</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-skip-consent-expire">OIDC_SKIP_CONSENT_EXPIRE</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-token-expire">OIDC_TOKEN_EXPIRE</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="settings.html#oidc-userinfo">OIDC_USERINFO</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribute</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="contribute.html#running-tests">Running Tests</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="indices-and-tables">
|
||
|
|
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<ul class="simple">
|
||
|
|
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
|
||
|
|
<li><a class="reference internal" href="py-modindex.html"><span>Module Index</span></a></li>
|
||
|
|
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
|
|
||
|
|
<a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>
|
||
|
|
© Copyright 2016, Juan Ignacio Fiorentino.
|
||
|
|
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT:'./',
|
||
|
|
VERSION:'0.2.5',
|
||
|
|
COLLAPSE_INDEX:false,
|
||
|
|
FILE_SUFFIX:'.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.StickyNav.enable();
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|