--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_ldap.html Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,641 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>pyams_ldap package — PyAMS User Guide 0.1.0 documentation</title>
+ <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </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>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+ </head>
+ <body>
+
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="pyams-ldap-package">
+<h1>pyams_ldap package<a class="headerlink" href="#pyams-ldap-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_ldap.interfaces.html">pyams_ldap.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.interfaces.html#module-pyams_ldap.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_ldap.tests.html">pyams_ldap.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#module-pyams_ldap.tests.test_utilsdocs">pyams_ldap.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#module-pyams_ldap.tests.test_utilsdocstrings">pyams_ldap.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#module-pyams_ldap.tests">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_ldap.zmi.html">pyams_ldap.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.zmi.html#module-pyams_ldap.zmi.plugin">pyams_ldap.zmi.plugin module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_ldap.zmi.html#module-pyams_ldap.zmi">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_ldap.plugin">
+<span id="pyams-ldap-plugin-module"></span><h2>pyams_ldap.plugin module<a class="headerlink" href="#module-pyams_ldap.plugin" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_ldap.plugin.ConnectionManager">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">ConnectionManager</code><span class="sig-paren">(</span><em>plugin</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.ConnectionManager" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>LDAP connections manager</p>
+<dl class="method">
+<dt id="pyams_ldap.plugin.ConnectionManager.get_connection">
+<code class="descname">get_connection</code><span class="sig-paren">(</span><em>user=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.ConnectionManager.get_connection" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_ldap.plugin.LDAPGroupInfo">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">LDAPGroupInfo</code><span class="sig-paren">(</span><em>dn</em>, <em>attributes</em>, <em>plugin=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPGroupInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>LDAP group info</p>
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPGroupInfo.get_members">
+<code class="descname">get_members</code><span class="sig-paren">(</span><em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPGroupInfo.get_members" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_ldap.plugin.LDAPGroupMailInfoAdapter">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">LDAPGroupMailInfoAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPGroupMailInfoAdapter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
+<p>LDAP group mail adapter</p>
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPGroupMailInfoAdapter.get_addresses">
+<code class="descname">get_addresses</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPGroupMailInfoAdapter.get_addresses" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get mail address of given group</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_ldap.plugin.LDAPPlugin">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">LDAPPlugin</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
+<p>LDAP authentication plug-in</p>
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.authenticate">
+<code class="descname">authenticate</code><span class="sig-paren">(</span><em>credentials</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.authenticate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.base_dn">
+<code class="descname">base_dn</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.base_dn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.bind_dn">
+<code class="descname">bind_dn</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.bind_dn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.bind_password">
+<code class="descname">bind_password</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.bind_password" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.clear">
+<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.clear" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.enabled">
+<code class="descname">enabled</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.enabled" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.find_principals">
+<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.find_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.get_all_principals">
+<code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.get_all_principals" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get all principals (including groups) for given principal ID</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.get_connection">
+<code class="descname">get_connection</code><span class="sig-paren">(</span><em>user=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.get_connection" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.get_members">
+<code class="descname">get_members</code><span class="sig-paren">(</span><em>group</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.get_members" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get all members of given LDAP group as LDAP users</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.get_principal">
+<code class="descname">get_principal</code><span class="sig-paren">(</span><em>principal_id</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.get_principal" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPPlugin.get_search_results">
+<code class="descname">get_search_results</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.get_search_results" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_extra_attributes">
+<code class="descname">group_extra_attributes</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_extra_attributes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_mail_attribute">
+<code class="descname">group_mail_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_mail_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_mail_mode">
+<code class="descname">group_mail_mode</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_mail_mode" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_members_attribute">
+<code class="descname">group_members_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_members_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_members_query_mode">
+<code class="descname">group_members_query_mode</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_members_query_mode" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_prefix">
+<code class="descname">group_prefix</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_prefix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_replace_expression">
+<code class="descname">group_replace_expression</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_replace_expression" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_title_format">
+<code class="descname">group_title_format</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_title_format" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.group_uid_attribute">
+<code class="descname">group_uid_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_uid_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.groups_base_dn">
+<code class="descname">groups_base_dn</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_base_dn" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.groups_query">
+<code class="descname">groups_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.groups_search_query">
+<code class="descname">groups_search_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_search_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.groups_search_scope">
+<code class="descname">groups_search_scope</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_search_scope" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.groups_select_query">
+<code class="descname">groups_select_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_select_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.host">
+<code class="descname">host</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.host" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.login_attribute">
+<code class="descname">login_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.login_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.login_query">
+<code class="descname">login_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.login_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.mail_attribute">
+<code class="descname">mail_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.mail_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.pool_lifetime">
+<code class="descname">pool_lifetime</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.pool_lifetime" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.pool_size">
+<code class="descname">pool_size</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.pool_size" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.port">
+<code class="descname">port</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.port" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.prefix">
+<code class="descname">prefix</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.prefix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.scheme">
+<code class="descname">scheme</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.scheme" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.search_scope">
+<code class="descname">search_scope</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.search_scope" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.server_uri">
+<code class="descname">server_uri</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.server_uri" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.title">
+<code class="descname">title</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.title" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.title_format">
+<code class="descname">title_format</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.title_format" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.uid_attribute">
+<code class="descname">uid_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.uid_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.uid_query">
+<code class="descname">uid_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.uid_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.use_pool">
+<code class="descname">use_pool</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_pool" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.use_ssl">
+<code class="descname">use_ssl</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_ssl" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.use_tls">
+<code class="descname">use_tls</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_tls" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.user_extra_attributes">
+<code class="descname">user_extra_attributes</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.user_extra_attributes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.user_groups_attribute">
+<code class="descname">user_groups_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.user_groups_attribute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.users_search_query">
+<code class="descname">users_search_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.users_search_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_ldap.plugin.LDAPPlugin.users_select_query">
+<code class="descname">users_select_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.users_select_query" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_ldap.plugin.LDAPUserInfo">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">LDAPUserInfo</code><span class="sig-paren">(</span><em>dn</em>, <em>attributes</em>, <em>plugin=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPUserInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>LDAP user info</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_ldap.plugin.LDAPUserMailInfoAdapter">
+<em class="property">class </em><code class="descclassname">pyams_ldap.plugin.</code><code class="descname">LDAPUserMailInfoAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPUserMailInfoAdapter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
+<p>LDAP user mail adapter</p>
+<dl class="method">
+<dt id="pyams_ldap.plugin.LDAPUserMailInfoAdapter.get_addresses">
+<code class="descname">get_addresses</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.plugin.LDAPUserMailInfoAdapter.get_addresses" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get mail address of given user</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_ldap.query">
+<span id="pyams-ldap-query-module"></span><h2>pyams_ldap.query module<a class="headerlink" href="#module-pyams_ldap.query" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_ldap.query.LDAPQuery">
+<em class="property">class </em><code class="descclassname">pyams_ldap.query.</code><code class="descname">LDAPQuery</code><span class="sig-paren">(</span><em>base_dn</em>, <em>filter_tmpl</em>, <em>scope</em>, <em>attributes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.query.LDAPQuery" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Object representing an LDAP query</p>
+<dl class="method">
+<dt id="pyams_ldap.query.LDAPQuery.execute">
+<code class="descname">execute</code><span class="sig-paren">(</span><em>conn</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.query.LDAPQuery.execute" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_ldap">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_ldap" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_ldap.includeme">
+<code class="descclassname">pyams_ldap.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_ldap.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">pyams_ldap package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_ldap.plugin">pyams_ldap.plugin module</a></li>
+<li><a class="reference internal" href="#module-pyams_ldap.query">pyams_ldap.query module</a></li>
+<li><a class="reference internal" href="#module-pyams_ldap">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2017, Thierry Florac.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+ </div>
+ </body>
+</html>
\ No newline at end of file