src/build/html/pyams_ldap.html
changeset 11 ba0b83b57c0c
parent 10 1d12ff3f036a
child 12 f1f1e99a6572
equal deleted inserted replaced
10:1d12ff3f036a 11:ba0b83b57c0c
     1 
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 
       
     5 <html xmlns="http://www.w3.org/1999/xhtml">
       
     6   <head>
       
     7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
       
     8     <title>pyams_ldap package &#8212; PyAMS User Guide 0.1.0 documentation</title>
       
     9     <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
       
    10     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       
    11     <script type="text/javascript">
       
    12       var DOCUMENTATION_OPTIONS = {
       
    13         URL_ROOT:    './',
       
    14         VERSION:     '0.1.0',
       
    15         COLLAPSE_INDEX: false,
       
    16         FILE_SUFFIX: '.html',
       
    17         HAS_SOURCE:  true,
       
    18         SOURCELINK_SUFFIX: '.txt'
       
    19       };
       
    20     </script>
       
    21     <script type="text/javascript" src="_static/jquery.js"></script>
       
    22     <script type="text/javascript" src="_static/underscore.js"></script>
       
    23     <script type="text/javascript" src="_static/doctools.js"></script>
       
    24     <link rel="index" title="Index" href="genindex.html" />
       
    25     <link rel="search" title="Search" href="search.html" />
       
    26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    28 <!--[if lte IE 6]>
       
    29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
       
    30 <![endif]-->
       
    31 
       
    32   </head>
       
    33   <body>
       
    34 
       
    35     <div class="related" role="navigation" aria-label="related navigation">
       
    36       <h3>Navigation</h3>
       
    37       <ul>
       
    38         <li class="right" style="margin-right: 10px">
       
    39           <a href="genindex.html" title="General Index"
       
    40              accesskey="I">index</a></li>
       
    41         <li class="right" >
       
    42           <a href="py-modindex.html" title="Python Module Index"
       
    43              >modules</a> |</li>
       
    44         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
    45       </ul>
       
    46     </div>  
       
    47 
       
    48     <div class="document">
       
    49       <div class="documentwrapper">
       
    50         <div class="bodywrapper">
       
    51           <div class="body" role="main">
       
    52             
       
    53   <div class="section" id="pyams-ldap-package">
       
    54 <h1>pyams_ldap package<a class="headerlink" href="#pyams-ldap-package" title="Permalink to this headline">¶</a></h1>
       
    55 <div class="section" id="subpackages">
       
    56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
       
    57 <div class="toctree-wrapper compound">
       
    58 <ul>
       
    59 <li class="toctree-l1"><a class="reference internal" href="pyams_ldap.interfaces.html">pyams_ldap.interfaces package</a><ul>
       
    60 <li class="toctree-l2"><a class="reference internal" href="pyams_ldap.interfaces.html#module-pyams_ldap.interfaces">Module contents</a></li>
       
    61 </ul>
       
    62 </li>
       
    63 <li class="toctree-l1"><a class="reference internal" href="pyams_ldap.tests.html">pyams_ldap.tests package</a><ul>
       
    64 <li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#submodules">Submodules</a></li>
       
    65 <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>
       
    66 <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>
       
    67 <li class="toctree-l2"><a class="reference internal" href="pyams_ldap.tests.html#module-pyams_ldap.tests">Module contents</a></li>
       
    68 </ul>
       
    69 </li>
       
    70 <li class="toctree-l1"><a class="reference internal" href="pyams_ldap.zmi.html">pyams_ldap.zmi package</a><ul>
       
    71 <li class="toctree-l2"><a class="reference internal" href="pyams_ldap.zmi.html#submodules">Submodules</a></li>
       
    72 <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>
       
    73 <li class="toctree-l2"><a class="reference internal" href="pyams_ldap.zmi.html#module-pyams_ldap.zmi">Module contents</a></li>
       
    74 </ul>
       
    75 </li>
       
    76 </ul>
       
    77 </div>
       
    78 </div>
       
    79 <div class="section" id="submodules">
       
    80 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    81 </div>
       
    82 <div class="section" id="module-pyams_ldap.plugin">
       
    83 <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>
       
    84 <dl class="class">
       
    85 <dt id="pyams_ldap.plugin.ConnectionManager">
       
    86 <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>
       
    87 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
    88 <p>LDAP connections manager</p>
       
    89 <dl class="method">
       
    90 <dt id="pyams_ldap.plugin.ConnectionManager.get_connection">
       
    91 <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>
       
    92 <dd></dd></dl>
       
    93 
       
    94 </dd></dl>
       
    95 
       
    96 <dl class="class">
       
    97 <dt id="pyams_ldap.plugin.LDAPGroupInfo">
       
    98 <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>
       
    99 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   100 <p>LDAP group info</p>
       
   101 <dl class="method">
       
   102 <dt id="pyams_ldap.plugin.LDAPGroupInfo.get_members">
       
   103 <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>
       
   104 <dd></dd></dl>
       
   105 
       
   106 </dd></dl>
       
   107 
       
   108 <dl class="class">
       
   109 <dt id="pyams_ldap.plugin.LDAPGroupMailInfoAdapter">
       
   110 <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>
       
   111 <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>
       
   112 <p>LDAP group mail adapter</p>
       
   113 <dl class="method">
       
   114 <dt id="pyams_ldap.plugin.LDAPGroupMailInfoAdapter.get_addresses">
       
   115 <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>
       
   116 <dd><p>Get mail address of given group</p>
       
   117 </dd></dl>
       
   118 
       
   119 </dd></dl>
       
   120 
       
   121 <dl class="class">
       
   122 <dt id="pyams_ldap.plugin.LDAPPlugin">
       
   123 <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>
       
   124 <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>
       
   125 <p>LDAP authentication plug-in</p>
       
   126 <dl class="method">
       
   127 <dt id="pyams_ldap.plugin.LDAPPlugin.authenticate">
       
   128 <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>
       
   129 <dd></dd></dl>
       
   130 
       
   131 <dl class="attribute">
       
   132 <dt id="pyams_ldap.plugin.LDAPPlugin.base_dn">
       
   133 <code class="descname">base_dn</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.base_dn" title="Permalink to this definition">¶</a></dt>
       
   134 <dd><p>Computed attributes based on schema fields</p>
       
   135 <p>Field properties provide default values, data validation and error messages
       
   136 based on data found in field meta-data.</p>
       
   137 <p>Note that FieldProperties cannot be used with slots. They can only
       
   138 be used for attributes stored in instance dictionaries.</p>
       
   139 </dd></dl>
       
   140 
       
   141 <dl class="attribute">
       
   142 <dt id="pyams_ldap.plugin.LDAPPlugin.bind_dn">
       
   143 <code class="descname">bind_dn</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.bind_dn" title="Permalink to this definition">¶</a></dt>
       
   144 <dd><p>Computed attributes based on schema fields</p>
       
   145 <p>Field properties provide default values, data validation and error messages
       
   146 based on data found in field meta-data.</p>
       
   147 <p>Note that FieldProperties cannot be used with slots. They can only
       
   148 be used for attributes stored in instance dictionaries.</p>
       
   149 </dd></dl>
       
   150 
       
   151 <dl class="attribute">
       
   152 <dt id="pyams_ldap.plugin.LDAPPlugin.bind_password">
       
   153 <code class="descname">bind_password</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.bind_password" title="Permalink to this definition">¶</a></dt>
       
   154 <dd><p>Computed attributes based on schema fields</p>
       
   155 <p>Field properties provide default values, data validation and error messages
       
   156 based on data found in field meta-data.</p>
       
   157 <p>Note that FieldProperties cannot be used with slots. They can only
       
   158 be used for attributes stored in instance dictionaries.</p>
       
   159 </dd></dl>
       
   160 
       
   161 <dl class="method">
       
   162 <dt id="pyams_ldap.plugin.LDAPPlugin.clear">
       
   163 <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>
       
   164 <dd></dd></dl>
       
   165 
       
   166 <dl class="attribute">
       
   167 <dt id="pyams_ldap.plugin.LDAPPlugin.enabled">
       
   168 <code class="descname">enabled</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.enabled" title="Permalink to this definition">¶</a></dt>
       
   169 <dd><p>Computed attributes based on schema fields</p>
       
   170 <p>Field properties provide default values, data validation and error messages
       
   171 based on data found in field meta-data.</p>
       
   172 <p>Note that FieldProperties cannot be used with slots. They can only
       
   173 be used for attributes stored in instance dictionaries.</p>
       
   174 </dd></dl>
       
   175 
       
   176 <dl class="method">
       
   177 <dt id="pyams_ldap.plugin.LDAPPlugin.find_principals">
       
   178 <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>
       
   179 <dd></dd></dl>
       
   180 
       
   181 <dl class="method">
       
   182 <dt id="pyams_ldap.plugin.LDAPPlugin.get_all_principals">
       
   183 <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>
       
   184 <dd><p>Get all principals (including groups) for given principal ID</p>
       
   185 </dd></dl>
       
   186 
       
   187 <dl class="method">
       
   188 <dt id="pyams_ldap.plugin.LDAPPlugin.get_connection">
       
   189 <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>
       
   190 <dd></dd></dl>
       
   191 
       
   192 <dl class="method">
       
   193 <dt id="pyams_ldap.plugin.LDAPPlugin.get_members">
       
   194 <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>
       
   195 <dd><p>Get all members of given LDAP group as LDAP users</p>
       
   196 </dd></dl>
       
   197 
       
   198 <dl class="method">
       
   199 <dt id="pyams_ldap.plugin.LDAPPlugin.get_principal">
       
   200 <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>
       
   201 <dd></dd></dl>
       
   202 
       
   203 <dl class="method">
       
   204 <dt id="pyams_ldap.plugin.LDAPPlugin.get_search_results">
       
   205 <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>
       
   206 <dd></dd></dl>
       
   207 
       
   208 <dl class="attribute">
       
   209 <dt id="pyams_ldap.plugin.LDAPPlugin.group_extra_attributes">
       
   210 <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>
       
   211 <dd><p>Computed attributes based on schema fields</p>
       
   212 <p>Field properties provide default values, data validation and error messages
       
   213 based on data found in field meta-data.</p>
       
   214 <p>Note that FieldProperties cannot be used with slots. They can only
       
   215 be used for attributes stored in instance dictionaries.</p>
       
   216 </dd></dl>
       
   217 
       
   218 <dl class="attribute">
       
   219 <dt id="pyams_ldap.plugin.LDAPPlugin.group_mail_attribute">
       
   220 <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>
       
   221 <dd><p>Computed attributes based on schema fields</p>
       
   222 <p>Field properties provide default values, data validation and error messages
       
   223 based on data found in field meta-data.</p>
       
   224 <p>Note that FieldProperties cannot be used with slots. They can only
       
   225 be used for attributes stored in instance dictionaries.</p>
       
   226 </dd></dl>
       
   227 
       
   228 <dl class="attribute">
       
   229 <dt id="pyams_ldap.plugin.LDAPPlugin.group_mail_mode">
       
   230 <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>
       
   231 <dd><p>Computed attributes based on schema fields</p>
       
   232 <p>Field properties provide default values, data validation and error messages
       
   233 based on data found in field meta-data.</p>
       
   234 <p>Note that FieldProperties cannot be used with slots. They can only
       
   235 be used for attributes stored in instance dictionaries.</p>
       
   236 </dd></dl>
       
   237 
       
   238 <dl class="attribute">
       
   239 <dt id="pyams_ldap.plugin.LDAPPlugin.group_members_attribute">
       
   240 <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>
       
   241 <dd><p>Computed attributes based on schema fields</p>
       
   242 <p>Field properties provide default values, data validation and error messages
       
   243 based on data found in field meta-data.</p>
       
   244 <p>Note that FieldProperties cannot be used with slots. They can only
       
   245 be used for attributes stored in instance dictionaries.</p>
       
   246 </dd></dl>
       
   247 
       
   248 <dl class="attribute">
       
   249 <dt id="pyams_ldap.plugin.LDAPPlugin.group_members_query_mode">
       
   250 <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>
       
   251 <dd><p>Computed attributes based on schema fields</p>
       
   252 <p>Field properties provide default values, data validation and error messages
       
   253 based on data found in field meta-data.</p>
       
   254 <p>Note that FieldProperties cannot be used with slots. They can only
       
   255 be used for attributes stored in instance dictionaries.</p>
       
   256 </dd></dl>
       
   257 
       
   258 <dl class="attribute">
       
   259 <dt id="pyams_ldap.plugin.LDAPPlugin.group_prefix">
       
   260 <code class="descname">group_prefix</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.group_prefix" title="Permalink to this definition">¶</a></dt>
       
   261 <dd><p>Computed attributes based on schema fields</p>
       
   262 <p>Field properties provide default values, data validation and error messages
       
   263 based on data found in field meta-data.</p>
       
   264 <p>Note that FieldProperties cannot be used with slots. They can only
       
   265 be used for attributes stored in instance dictionaries.</p>
       
   266 </dd></dl>
       
   267 
       
   268 <dl class="attribute">
       
   269 <dt id="pyams_ldap.plugin.LDAPPlugin.group_replace_expression">
       
   270 <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>
       
   271 <dd><p>Computed attributes based on schema fields</p>
       
   272 <p>Field properties provide default values, data validation and error messages
       
   273 based on data found in field meta-data.</p>
       
   274 <p>Note that FieldProperties cannot be used with slots. They can only
       
   275 be used for attributes stored in instance dictionaries.</p>
       
   276 </dd></dl>
       
   277 
       
   278 <dl class="attribute">
       
   279 <dt id="pyams_ldap.plugin.LDAPPlugin.group_title_format">
       
   280 <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>
       
   281 <dd><p>Computed attributes based on schema fields</p>
       
   282 <p>Field properties provide default values, data validation and error messages
       
   283 based on data found in field meta-data.</p>
       
   284 <p>Note that FieldProperties cannot be used with slots. They can only
       
   285 be used for attributes stored in instance dictionaries.</p>
       
   286 </dd></dl>
       
   287 
       
   288 <dl class="attribute">
       
   289 <dt id="pyams_ldap.plugin.LDAPPlugin.group_uid_attribute">
       
   290 <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>
       
   291 <dd><p>Computed attributes based on schema fields</p>
       
   292 <p>Field properties provide default values, data validation and error messages
       
   293 based on data found in field meta-data.</p>
       
   294 <p>Note that FieldProperties cannot be used with slots. They can only
       
   295 be used for attributes stored in instance dictionaries.</p>
       
   296 </dd></dl>
       
   297 
       
   298 <dl class="attribute">
       
   299 <dt id="pyams_ldap.plugin.LDAPPlugin.groups_base_dn">
       
   300 <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>
       
   301 <dd><p>Computed attributes based on schema fields</p>
       
   302 <p>Field properties provide default values, data validation and error messages
       
   303 based on data found in field meta-data.</p>
       
   304 <p>Note that FieldProperties cannot be used with slots. They can only
       
   305 be used for attributes stored in instance dictionaries.</p>
       
   306 </dd></dl>
       
   307 
       
   308 <dl class="attribute">
       
   309 <dt id="pyams_ldap.plugin.LDAPPlugin.groups_query">
       
   310 <code class="descname">groups_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.groups_query" title="Permalink to this definition">¶</a></dt>
       
   311 <dd><p>Computed attributes based on schema fields</p>
       
   312 <p>Field properties provide default values, data validation and error messages
       
   313 based on data found in field meta-data.</p>
       
   314 <p>Note that FieldProperties cannot be used with slots. They can only
       
   315 be used for attributes stored in instance dictionaries.</p>
       
   316 </dd></dl>
       
   317 
       
   318 <dl class="attribute">
       
   319 <dt id="pyams_ldap.plugin.LDAPPlugin.groups_search_query">
       
   320 <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>
       
   321 <dd><p>Computed attributes based on schema fields</p>
       
   322 <p>Field properties provide default values, data validation and error messages
       
   323 based on data found in field meta-data.</p>
       
   324 <p>Note that FieldProperties cannot be used with slots. They can only
       
   325 be used for attributes stored in instance dictionaries.</p>
       
   326 </dd></dl>
       
   327 
       
   328 <dl class="attribute">
       
   329 <dt id="pyams_ldap.plugin.LDAPPlugin.groups_search_scope">
       
   330 <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>
       
   331 <dd><p>Computed attributes based on schema fields</p>
       
   332 <p>Field properties provide default values, data validation and error messages
       
   333 based on data found in field meta-data.</p>
       
   334 <p>Note that FieldProperties cannot be used with slots. They can only
       
   335 be used for attributes stored in instance dictionaries.</p>
       
   336 </dd></dl>
       
   337 
       
   338 <dl class="attribute">
       
   339 <dt id="pyams_ldap.plugin.LDAPPlugin.groups_select_query">
       
   340 <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>
       
   341 <dd><p>Computed attributes based on schema fields</p>
       
   342 <p>Field properties provide default values, data validation and error messages
       
   343 based on data found in field meta-data.</p>
       
   344 <p>Note that FieldProperties cannot be used with slots. They can only
       
   345 be used for attributes stored in instance dictionaries.</p>
       
   346 </dd></dl>
       
   347 
       
   348 <dl class="attribute">
       
   349 <dt id="pyams_ldap.plugin.LDAPPlugin.host">
       
   350 <code class="descname">host</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.host" title="Permalink to this definition">¶</a></dt>
       
   351 <dd></dd></dl>
       
   352 
       
   353 <dl class="attribute">
       
   354 <dt id="pyams_ldap.plugin.LDAPPlugin.login_attribute">
       
   355 <code class="descname">login_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.login_attribute" title="Permalink to this definition">¶</a></dt>
       
   356 <dd><p>Computed attributes based on schema fields</p>
       
   357 <p>Field properties provide default values, data validation and error messages
       
   358 based on data found in field meta-data.</p>
       
   359 <p>Note that FieldProperties cannot be used with slots. They can only
       
   360 be used for attributes stored in instance dictionaries.</p>
       
   361 </dd></dl>
       
   362 
       
   363 <dl class="attribute">
       
   364 <dt id="pyams_ldap.plugin.LDAPPlugin.login_query">
       
   365 <code class="descname">login_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.login_query" title="Permalink to this definition">¶</a></dt>
       
   366 <dd><p>Computed attributes based on schema fields</p>
       
   367 <p>Field properties provide default values, data validation and error messages
       
   368 based on data found in field meta-data.</p>
       
   369 <p>Note that FieldProperties cannot be used with slots. They can only
       
   370 be used for attributes stored in instance dictionaries.</p>
       
   371 </dd></dl>
       
   372 
       
   373 <dl class="attribute">
       
   374 <dt id="pyams_ldap.plugin.LDAPPlugin.mail_attribute">
       
   375 <code class="descname">mail_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.mail_attribute" title="Permalink to this definition">¶</a></dt>
       
   376 <dd><p>Computed attributes based on schema fields</p>
       
   377 <p>Field properties provide default values, data validation and error messages
       
   378 based on data found in field meta-data.</p>
       
   379 <p>Note that FieldProperties cannot be used with slots. They can only
       
   380 be used for attributes stored in instance dictionaries.</p>
       
   381 </dd></dl>
       
   382 
       
   383 <dl class="attribute">
       
   384 <dt id="pyams_ldap.plugin.LDAPPlugin.pool_lifetime">
       
   385 <code class="descname">pool_lifetime</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.pool_lifetime" title="Permalink to this definition">¶</a></dt>
       
   386 <dd><p>Computed attributes based on schema fields</p>
       
   387 <p>Field properties provide default values, data validation and error messages
       
   388 based on data found in field meta-data.</p>
       
   389 <p>Note that FieldProperties cannot be used with slots. They can only
       
   390 be used for attributes stored in instance dictionaries.</p>
       
   391 </dd></dl>
       
   392 
       
   393 <dl class="attribute">
       
   394 <dt id="pyams_ldap.plugin.LDAPPlugin.pool_size">
       
   395 <code class="descname">pool_size</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.pool_size" title="Permalink to this definition">¶</a></dt>
       
   396 <dd><p>Computed attributes based on schema fields</p>
       
   397 <p>Field properties provide default values, data validation and error messages
       
   398 based on data found in field meta-data.</p>
       
   399 <p>Note that FieldProperties cannot be used with slots. They can only
       
   400 be used for attributes stored in instance dictionaries.</p>
       
   401 </dd></dl>
       
   402 
       
   403 <dl class="attribute">
       
   404 <dt id="pyams_ldap.plugin.LDAPPlugin.port">
       
   405 <code class="descname">port</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.port" title="Permalink to this definition">¶</a></dt>
       
   406 <dd></dd></dl>
       
   407 
       
   408 <dl class="attribute">
       
   409 <dt id="pyams_ldap.plugin.LDAPPlugin.prefix">
       
   410 <code class="descname">prefix</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.prefix" title="Permalink to this definition">¶</a></dt>
       
   411 <dd><p>Computed attributes based on schema fields</p>
       
   412 <p>Field properties provide default values, data validation and error messages
       
   413 based on data found in field meta-data.</p>
       
   414 <p>Note that FieldProperties cannot be used with slots. They can only
       
   415 be used for attributes stored in instance dictionaries.</p>
       
   416 </dd></dl>
       
   417 
       
   418 <dl class="attribute">
       
   419 <dt id="pyams_ldap.plugin.LDAPPlugin.scheme">
       
   420 <code class="descname">scheme</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.scheme" title="Permalink to this definition">¶</a></dt>
       
   421 <dd></dd></dl>
       
   422 
       
   423 <dl class="attribute">
       
   424 <dt id="pyams_ldap.plugin.LDAPPlugin.search_scope">
       
   425 <code class="descname">search_scope</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.search_scope" title="Permalink to this definition">¶</a></dt>
       
   426 <dd><p>Computed attributes based on schema fields</p>
       
   427 <p>Field properties provide default values, data validation and error messages
       
   428 based on data found in field meta-data.</p>
       
   429 <p>Note that FieldProperties cannot be used with slots. They can only
       
   430 be used for attributes stored in instance dictionaries.</p>
       
   431 </dd></dl>
       
   432 
       
   433 <dl class="attribute">
       
   434 <dt id="pyams_ldap.plugin.LDAPPlugin.server_uri">
       
   435 <code class="descname">server_uri</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.server_uri" title="Permalink to this definition">¶</a></dt>
       
   436 <dd></dd></dl>
       
   437 
       
   438 <dl class="attribute">
       
   439 <dt id="pyams_ldap.plugin.LDAPPlugin.title">
       
   440 <code class="descname">title</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.title" title="Permalink to this definition">¶</a></dt>
       
   441 <dd><p>Computed attributes based on schema fields</p>
       
   442 <p>Field properties provide default values, data validation and error messages
       
   443 based on data found in field meta-data.</p>
       
   444 <p>Note that FieldProperties cannot be used with slots. They can only
       
   445 be used for attributes stored in instance dictionaries.</p>
       
   446 </dd></dl>
       
   447 
       
   448 <dl class="attribute">
       
   449 <dt id="pyams_ldap.plugin.LDAPPlugin.title_format">
       
   450 <code class="descname">title_format</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.title_format" title="Permalink to this definition">¶</a></dt>
       
   451 <dd><p>Computed attributes based on schema fields</p>
       
   452 <p>Field properties provide default values, data validation and error messages
       
   453 based on data found in field meta-data.</p>
       
   454 <p>Note that FieldProperties cannot be used with slots. They can only
       
   455 be used for attributes stored in instance dictionaries.</p>
       
   456 </dd></dl>
       
   457 
       
   458 <dl class="attribute">
       
   459 <dt id="pyams_ldap.plugin.LDAPPlugin.uid_attribute">
       
   460 <code class="descname">uid_attribute</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.uid_attribute" title="Permalink to this definition">¶</a></dt>
       
   461 <dd><p>Computed attributes based on schema fields</p>
       
   462 <p>Field properties provide default values, data validation and error messages
       
   463 based on data found in field meta-data.</p>
       
   464 <p>Note that FieldProperties cannot be used with slots. They can only
       
   465 be used for attributes stored in instance dictionaries.</p>
       
   466 </dd></dl>
       
   467 
       
   468 <dl class="attribute">
       
   469 <dt id="pyams_ldap.plugin.LDAPPlugin.uid_query">
       
   470 <code class="descname">uid_query</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.uid_query" title="Permalink to this definition">¶</a></dt>
       
   471 <dd><p>Computed attributes based on schema fields</p>
       
   472 <p>Field properties provide default values, data validation and error messages
       
   473 based on data found in field meta-data.</p>
       
   474 <p>Note that FieldProperties cannot be used with slots. They can only
       
   475 be used for attributes stored in instance dictionaries.</p>
       
   476 </dd></dl>
       
   477 
       
   478 <dl class="attribute">
       
   479 <dt id="pyams_ldap.plugin.LDAPPlugin.use_pool">
       
   480 <code class="descname">use_pool</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_pool" title="Permalink to this definition">¶</a></dt>
       
   481 <dd><p>Computed attributes based on schema fields</p>
       
   482 <p>Field properties provide default values, data validation and error messages
       
   483 based on data found in field meta-data.</p>
       
   484 <p>Note that FieldProperties cannot be used with slots. They can only
       
   485 be used for attributes stored in instance dictionaries.</p>
       
   486 </dd></dl>
       
   487 
       
   488 <dl class="attribute">
       
   489 <dt id="pyams_ldap.plugin.LDAPPlugin.use_ssl">
       
   490 <code class="descname">use_ssl</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_ssl" title="Permalink to this definition">¶</a></dt>
       
   491 <dd></dd></dl>
       
   492 
       
   493 <dl class="attribute">
       
   494 <dt id="pyams_ldap.plugin.LDAPPlugin.use_tls">
       
   495 <code class="descname">use_tls</code><a class="headerlink" href="#pyams_ldap.plugin.LDAPPlugin.use_tls" title="Permalink to this definition">¶</a></dt>
       
   496 <dd><p>Computed attributes based on schema fields</p>
       
   497 <p>Field properties provide default values, data validation and error messages
       
   498 based on data found in field meta-data.</p>
       
   499 <p>Note that FieldProperties cannot be used with slots. They can only
       
   500 be used for attributes stored in instance dictionaries.</p>
       
   501 </dd></dl>
       
   502 
       
   503 <dl class="attribute">
       
   504 <dt id="pyams_ldap.plugin.LDAPPlugin.user_extra_attributes">
       
   505 <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>
       
   506 <dd><p>Computed attributes based on schema fields</p>
       
   507 <p>Field properties provide default values, data validation and error messages
       
   508 based on data found in field meta-data.</p>
       
   509 <p>Note that FieldProperties cannot be used with slots. They can only
       
   510 be used for attributes stored in instance dictionaries.</p>
       
   511 </dd></dl>
       
   512 
       
   513 <dl class="attribute">
       
   514 <dt id="pyams_ldap.plugin.LDAPPlugin.user_groups_attribute">
       
   515 <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>
       
   516 <dd><p>Computed attributes based on schema fields</p>
       
   517 <p>Field properties provide default values, data validation and error messages
       
   518 based on data found in field meta-data.</p>
       
   519 <p>Note that FieldProperties cannot be used with slots. They can only
       
   520 be used for attributes stored in instance dictionaries.</p>
       
   521 </dd></dl>
       
   522 
       
   523 <dl class="attribute">
       
   524 <dt id="pyams_ldap.plugin.LDAPPlugin.users_search_query">
       
   525 <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>
       
   526 <dd><p>Computed attributes based on schema fields</p>
       
   527 <p>Field properties provide default values, data validation and error messages
       
   528 based on data found in field meta-data.</p>
       
   529 <p>Note that FieldProperties cannot be used with slots. They can only
       
   530 be used for attributes stored in instance dictionaries.</p>
       
   531 </dd></dl>
       
   532 
       
   533 <dl class="attribute">
       
   534 <dt id="pyams_ldap.plugin.LDAPPlugin.users_select_query">
       
   535 <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>
       
   536 <dd><p>Computed attributes based on schema fields</p>
       
   537 <p>Field properties provide default values, data validation and error messages
       
   538 based on data found in field meta-data.</p>
       
   539 <p>Note that FieldProperties cannot be used with slots. They can only
       
   540 be used for attributes stored in instance dictionaries.</p>
       
   541 </dd></dl>
       
   542 
       
   543 </dd></dl>
       
   544 
       
   545 <dl class="class">
       
   546 <dt id="pyams_ldap.plugin.LDAPUserInfo">
       
   547 <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>
       
   548 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   549 <p>LDAP user info</p>
       
   550 </dd></dl>
       
   551 
       
   552 <dl class="class">
       
   553 <dt id="pyams_ldap.plugin.LDAPUserMailInfoAdapter">
       
   554 <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>
       
   555 <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>
       
   556 <p>LDAP user mail adapter</p>
       
   557 <dl class="method">
       
   558 <dt id="pyams_ldap.plugin.LDAPUserMailInfoAdapter.get_addresses">
       
   559 <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>
       
   560 <dd><p>Get mail address of given user</p>
       
   561 </dd></dl>
       
   562 
       
   563 </dd></dl>
       
   564 
       
   565 </div>
       
   566 <div class="section" id="module-pyams_ldap.query">
       
   567 <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>
       
   568 <dl class="class">
       
   569 <dt id="pyams_ldap.query.LDAPQuery">
       
   570 <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>
       
   571 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   572 <p>Object representing an LDAP query</p>
       
   573 <dl class="method">
       
   574 <dt id="pyams_ldap.query.LDAPQuery.execute">
       
   575 <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>
       
   576 <dd></dd></dl>
       
   577 
       
   578 </dd></dl>
       
   579 
       
   580 </div>
       
   581 <div class="section" id="module-pyams_ldap">
       
   582 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_ldap" title="Permalink to this headline">¶</a></h2>
       
   583 <dl class="function">
       
   584 <dt id="pyams_ldap.includeme">
       
   585 <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>
       
   586 <dd><p>Pyramid include</p>
       
   587 </dd></dl>
       
   588 
       
   589 </div>
       
   590 </div>
       
   591 
       
   592 
       
   593           </div>
       
   594         </div>
       
   595       </div>
       
   596       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
   597         <div class="sphinxsidebarwrapper">
       
   598   <h3><a href="index.html">Table Of Contents</a></h3>
       
   599   <ul>
       
   600 <li><a class="reference internal" href="#">pyams_ldap package</a><ul>
       
   601 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
       
   602 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
   603 <li><a class="reference internal" href="#module-pyams_ldap.plugin">pyams_ldap.plugin module</a></li>
       
   604 <li><a class="reference internal" href="#module-pyams_ldap.query">pyams_ldap.query module</a></li>
       
   605 <li><a class="reference internal" href="#module-pyams_ldap">Module contents</a></li>
       
   606 </ul>
       
   607 </li>
       
   608 </ul>
       
   609 
       
   610 <div id="searchbox" style="display: none" role="search">
       
   611   <h3>Quick search</h3>
       
   612     <form class="search" action="search.html" method="get">
       
   613       <div><input type="text" name="q" /></div>
       
   614       <div><input type="submit" value="Go" /></div>
       
   615       <input type="hidden" name="check_keywords" value="yes" />
       
   616       <input type="hidden" name="area" value="default" />
       
   617     </form>
       
   618 </div>
       
   619 <script type="text/javascript">$('#searchbox').show(0);</script>
       
   620         </div>
       
   621       </div>
       
   622       <div class="clearer"></div>
       
   623     </div>
       
   624     <div class="related" role="navigation" aria-label="related navigation">
       
   625       <h3>Navigation</h3>
       
   626       <ul>
       
   627         <li class="right" style="margin-right: 10px">
       
   628           <a href="genindex.html" title="General Index"
       
   629              >index</a></li>
       
   630         <li class="right" >
       
   631           <a href="py-modindex.html" title="Python Module Index"
       
   632              >modules</a> |</li>
       
   633         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
   634       </ul>
       
   635     </div>
       
   636     <div class="footer" role="contentinfo">
       
   637         &#169; Copyright 2017, Thierry Florac.
       
   638       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
       
   639     </div>
       
   640   </body>
       
   641 </html>