src/build/html/pyams_security.plugin.html
changeset 0 d153941bb745
equal deleted inserted replaced
-1:000000000000 0:d153941bb745
       
     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_security.plugin 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-security-plugin-package">
       
    54 <h1>pyams_security.plugin package<a class="headerlink" href="#pyams-security-plugin-package" title="Permalink to this headline">¶</a></h1>
       
    55 <div class="section" id="submodules">
       
    56 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    57 </div>
       
    58 <div class="section" id="module-pyams_security.plugin.admin">
       
    59 <span id="pyams-security-plugin-admin-module"></span><h2>pyams_security.plugin.admin module<a class="headerlink" href="#module-pyams_security.plugin.admin" title="Permalink to this headline">¶</a></h2>
       
    60 <dl class="class">
       
    61 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin">
       
    62 <em class="property">class </em><code class="descclassname">pyams_security.plugin.admin.</code><code class="descname">AdminAuthenticationPlugin</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin" title="Permalink to this definition">¶</a></dt>
       
    63 <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>
       
    64 <p>Hard-coded administrator authenticator plug-in</p>
       
    65 <p>This plug-in should only be enabled in development mode!!!</p>
       
    66 <dl class="method">
       
    67 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.authenticate">
       
    68 <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_security.plugin.admin.AdminAuthenticationPlugin.authenticate" title="Permalink to this definition">¶</a></dt>
       
    69 <dd></dd></dl>
       
    70 
       
    71 <dl class="attribute">
       
    72 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.enabled">
       
    73 <code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.enabled" title="Permalink to this definition">¶</a></dt>
       
    74 <dd><p>Computed attributes based on schema fields</p>
       
    75 <p>Field properties provide default values, data validation and error messages
       
    76 based on data found in field meta-data.</p>
       
    77 <p>Note that FieldProperties cannot be used with slots. They can only
       
    78 be used for attributes stored in instance dictionaries.</p>
       
    79 </dd></dl>
       
    80 
       
    81 <dl class="method">
       
    82 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.find_principals">
       
    83 <code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.find_principals" title="Permalink to this definition">¶</a></dt>
       
    84 <dd></dd></dl>
       
    85 
       
    86 <dl class="method">
       
    87 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.get_all_principals">
       
    88 <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_security.plugin.admin.AdminAuthenticationPlugin.get_all_principals" title="Permalink to this definition">¶</a></dt>
       
    89 <dd></dd></dl>
       
    90 
       
    91 <dl class="method">
       
    92 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.get_principal">
       
    93 <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_security.plugin.admin.AdminAuthenticationPlugin.get_principal" title="Permalink to this definition">¶</a></dt>
       
    94 <dd></dd></dl>
       
    95 
       
    96 <dl class="attribute">
       
    97 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.login">
       
    98 <code class="descname">login</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.login" title="Permalink to this definition">¶</a></dt>
       
    99 <dd><p>Computed attributes based on schema fields</p>
       
   100 <p>Field properties provide default values, data validation and error messages
       
   101 based on data found in field meta-data.</p>
       
   102 <p>Note that FieldProperties cannot be used with slots. They can only
       
   103 be used for attributes stored in instance dictionaries.</p>
       
   104 </dd></dl>
       
   105 
       
   106 <dl class="attribute">
       
   107 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.password">
       
   108 <code class="descname">password</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.password" title="Permalink to this definition">¶</a></dt>
       
   109 <dd></dd></dl>
       
   110 
       
   111 <dl class="attribute">
       
   112 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.prefix">
       
   113 <code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.prefix" title="Permalink to this definition">¶</a></dt>
       
   114 <dd><p>Computed attributes based on schema fields</p>
       
   115 <p>Field properties provide default values, data validation and error messages
       
   116 based on data found in field meta-data.</p>
       
   117 <p>Note that FieldProperties cannot be used with slots. They can only
       
   118 be used for attributes stored in instance dictionaries.</p>
       
   119 </dd></dl>
       
   120 
       
   121 <dl class="attribute">
       
   122 <dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.title">
       
   123 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.title" title="Permalink to this definition">¶</a></dt>
       
   124 <dd><p>Computed attributes based on schema fields</p>
       
   125 <p>Field properties provide default values, data validation and error messages
       
   126 based on data found in field meta-data.</p>
       
   127 <p>Note that FieldProperties cannot be used with slots. They can only
       
   128 be used for attributes stored in instance dictionaries.</p>
       
   129 </dd></dl>
       
   130 
       
   131 </dd></dl>
       
   132 
       
   133 </div>
       
   134 <div class="section" id="module-pyams_security.plugin.group">
       
   135 <span id="pyams-security-plugin-group-module"></span><h2>pyams_security.plugin.group module<a class="headerlink" href="#module-pyams_security.plugin.group" title="Permalink to this headline">¶</a></h2>
       
   136 <dl class="class">
       
   137 <dt id="pyams_security.plugin.group.Group">
       
   138 <em class="property">class </em><code class="descclassname">pyams_security.plugin.group.</code><code class="descname">Group</code><a class="headerlink" href="#pyams_security.plugin.group.Group" title="Permalink to this definition">¶</a></dt>
       
   139 <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>
       
   140 <p>Local group persistent class</p>
       
   141 <dl class="attribute">
       
   142 <dt id="pyams_security.plugin.group.Group.description">
       
   143 <code class="descname">description</code><a class="headerlink" href="#pyams_security.plugin.group.Group.description" 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_security.plugin.group.Group.group_id">
       
   153 <code class="descname">group_id</code><a class="headerlink" href="#pyams_security.plugin.group.Group.group_id" 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="attribute">
       
   162 <dt id="pyams_security.plugin.group.Group.principals">
       
   163 <code class="descname">principals</code><a class="headerlink" href="#pyams_security.plugin.group.Group.principals" title="Permalink to this definition">¶</a></dt>
       
   164 <dd></dd></dl>
       
   165 
       
   166 <dl class="attribute">
       
   167 <dt id="pyams_security.plugin.group.Group.title">
       
   168 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.group.Group.title" 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 </dd></dl>
       
   177 
       
   178 <dl class="class">
       
   179 <dt id="pyams_security.plugin.group.GroupsFolder">
       
   180 <em class="property">class </em><code class="descclassname">pyams_security.plugin.group.</code><code class="descname">GroupsFolder</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder" title="Permalink to this definition">¶</a></dt>
       
   181 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   182 <p>Principals groups folder</p>
       
   183 <dl class="method">
       
   184 <dt id="pyams_security.plugin.group.GroupsFolder.check_group_id">
       
   185 <code class="descname">check_group_id</code><span class="sig-paren">(</span><em>group_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.check_group_id" title="Permalink to this definition">¶</a></dt>
       
   186 <dd><p>Check for existence of given group ID</p>
       
   187 </dd></dl>
       
   188 
       
   189 <dl class="attribute">
       
   190 <dt id="pyams_security.plugin.group.GroupsFolder.enabled">
       
   191 <code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.enabled" title="Permalink to this definition">¶</a></dt>
       
   192 <dd><p>Computed attributes based on schema fields</p>
       
   193 <p>Field properties provide default values, data validation and error messages
       
   194 based on data found in field meta-data.</p>
       
   195 <p>Note that FieldProperties cannot be used with slots. They can only
       
   196 be used for attributes stored in instance dictionaries.</p>
       
   197 </dd></dl>
       
   198 
       
   199 <dl class="method">
       
   200 <dt id="pyams_security.plugin.group.GroupsFolder.find_principals">
       
   201 <code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.find_principals" title="Permalink to this definition">¶</a></dt>
       
   202 <dd></dd></dl>
       
   203 
       
   204 <dl class="method">
       
   205 <dt id="pyams_security.plugin.group.GroupsFolder.get_all_principals">
       
   206 <code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em>, <em>seen=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.get_all_principals" title="Permalink to this definition">¶</a></dt>
       
   207 <dd></dd></dl>
       
   208 
       
   209 <dl class="method">
       
   210 <dt id="pyams_security.plugin.group.GroupsFolder.get_principal">
       
   211 <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_security.plugin.group.GroupsFolder.get_principal" title="Permalink to this definition">¶</a></dt>
       
   212 <dd></dd></dl>
       
   213 
       
   214 <dl class="attribute">
       
   215 <dt id="pyams_security.plugin.group.GroupsFolder.prefix">
       
   216 <code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.prefix" title="Permalink to this definition">¶</a></dt>
       
   217 <dd><p>Computed attributes based on schema fields</p>
       
   218 <p>Field properties provide default values, data validation and error messages
       
   219 based on data found in field meta-data.</p>
       
   220 <p>Note that FieldProperties cannot be used with slots. They can only
       
   221 be used for attributes stored in instance dictionaries.</p>
       
   222 </dd></dl>
       
   223 
       
   224 <dl class="attribute">
       
   225 <dt id="pyams_security.plugin.group.GroupsFolder.title">
       
   226 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.title" title="Permalink to this definition">¶</a></dt>
       
   227 <dd><p>Computed attributes based on schema fields</p>
       
   228 <p>Field properties provide default values, data validation and error messages
       
   229 based on data found in field meta-data.</p>
       
   230 <p>Note that FieldProperties cannot be used with slots. They can only
       
   231 be used for attributes stored in instance dictionaries.</p>
       
   232 </dd></dl>
       
   233 
       
   234 </dd></dl>
       
   235 
       
   236 <dl class="class">
       
   237 <dt id="pyams_security.plugin.group.LocalGroupsVocabulary">
       
   238 <em class="property">class </em><code class="descclassname">pyams_security.plugin.group.</code><code class="descname">LocalGroupsVocabulary</code><span class="sig-paren">(</span><em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.LocalGroupsVocabulary" title="Permalink to this definition">¶</a></dt>
       
   239 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
       
   240 <p>‘PyAMS local groups vocabulary</p>
       
   241 </dd></dl>
       
   242 
       
   243 <dl class="function">
       
   244 <dt id="pyams_security.plugin.group.handle_added_group">
       
   245 <code class="descclassname">pyams_security.plugin.group.</code><code class="descname">handle_added_group</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.handle_added_group" title="Permalink to this definition">¶</a></dt>
       
   246 <dd><p>Handle added group</p>
       
   247 </dd></dl>
       
   248 
       
   249 <dl class="function">
       
   250 <dt id="pyams_security.plugin.group.handle_added_principals">
       
   251 <code class="descclassname">pyams_security.plugin.group.</code><code class="descname">handle_added_principals</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.handle_added_principals" title="Permalink to this definition">¶</a></dt>
       
   252 <dd><p>Handle principals added to group</p>
       
   253 </dd></dl>
       
   254 
       
   255 <dl class="function">
       
   256 <dt id="pyams_security.plugin.group.handle_removed_principals">
       
   257 <code class="descclassname">pyams_security.plugin.group.</code><code class="descname">handle_removed_principals</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.handle_removed_principals" title="Permalink to this definition">¶</a></dt>
       
   258 <dd><p>Handle principals removed from group</p>
       
   259 </dd></dl>
       
   260 
       
   261 </div>
       
   262 <div class="section" id="module-pyams_security.plugin.http">
       
   263 <span id="pyams-security-plugin-http-module"></span><h2>pyams_security.plugin.http module<a class="headerlink" href="#module-pyams_security.plugin.http" title="Permalink to this headline">¶</a></h2>
       
   264 <dl class="class">
       
   265 <dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin">
       
   266 <em class="property">class </em><code class="descclassname">pyams_security.plugin.http.</code><code class="descname">HttpBasicCredentialsPlugin</code><a class="headerlink" href="#pyams_security.plugin.http.HttpBasicCredentialsPlugin" title="Permalink to this definition">¶</a></dt>
       
   267 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   268 <p>HTTP basic credentials plug-in</p>
       
   269 <p>This credential plug-in is mainly used by automation processes using
       
   270 XML-RPC or JSON-RPC requests launched from batch scripts.</p>
       
   271 <p>Copied from pyramid_httpauth package.</p>
       
   272 <dl class="attribute">
       
   273 <dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.enabled">
       
   274 <code class="descname">enabled</code><em class="property"> = True</em><a class="headerlink" href="#pyams_security.plugin.http.HttpBasicCredentialsPlugin.enabled" title="Permalink to this definition">¶</a></dt>
       
   275 <dd></dd></dl>
       
   276 
       
   277 <dl class="method">
       
   278 <dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.extract_credentials">
       
   279 <code class="descname">extract_credentials</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.http.HttpBasicCredentialsPlugin.extract_credentials" title="Permalink to this definition">¶</a></dt>
       
   280 <dd></dd></dl>
       
   281 
       
   282 <dl class="attribute">
       
   283 <dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.prefix">
       
   284 <code class="descname">prefix</code><em class="property"> = 'http'</em><a class="headerlink" href="#pyams_security.plugin.http.HttpBasicCredentialsPlugin.prefix" title="Permalink to this definition">¶</a></dt>
       
   285 <dd></dd></dl>
       
   286 
       
   287 <dl class="attribute">
       
   288 <dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.title">
       
   289 <code class="descname">title</code><em class="property"> = 'HTTP Basic credentials'</em><a class="headerlink" href="#pyams_security.plugin.http.HttpBasicCredentialsPlugin.title" title="Permalink to this definition">¶</a></dt>
       
   290 <dd></dd></dl>
       
   291 
       
   292 </dd></dl>
       
   293 
       
   294 </div>
       
   295 <div class="section" id="module-pyams_security.plugin.social">
       
   296 <span id="pyams-security-plugin-social-module"></span><h2>pyams_security.plugin.social module<a class="headerlink" href="#module-pyams_security.plugin.social" title="Permalink to this headline">¶</a></h2>
       
   297 <dl class="class">
       
   298 <dt id="pyams_security.plugin.social.OAuthProvidersVocabulary">
       
   299 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">OAuthProvidersVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.OAuthProvidersVocabulary" title="Permalink to this definition">¶</a></dt>
       
   300 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
       
   301 <p>OAuth providers vocabulary</p>
       
   302 </dd></dl>
       
   303 
       
   304 <dl class="class">
       
   305 <dt id="pyams_security.plugin.social.SecurityManagerSocialTraverser">
       
   306 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SecurityManagerSocialTraverser</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SecurityManagerSocialTraverser" title="Permalink to this definition">¶</a></dt>
       
   307 <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>
       
   308 <p>++social-configuration++ namespace traverser</p>
       
   309 <dl class="method">
       
   310 <dt id="pyams_security.plugin.social.SecurityManagerSocialTraverser.traverse">
       
   311 <code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SecurityManagerSocialTraverser.traverse" title="Permalink to this definition">¶</a></dt>
       
   312 <dd></dd></dl>
       
   313 
       
   314 </dd></dl>
       
   315 
       
   316 <dl class="class">
       
   317 <dt id="pyams_security.plugin.social.SocialLoginConfiguration">
       
   318 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialLoginConfiguration</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginConfiguration" title="Permalink to this definition">¶</a></dt>
       
   319 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   320 <p>Social login configuration</p>
       
   321 <dl class="method">
       
   322 <dt id="pyams_security.plugin.social.SocialLoginConfiguration.get_oauth_configuration">
       
   323 <code class="descname">get_oauth_configuration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginConfiguration.get_oauth_configuration" title="Permalink to this definition">¶</a></dt>
       
   324 <dd></dd></dl>
       
   325 
       
   326 </dd></dl>
       
   327 
       
   328 <dl class="function">
       
   329 <dt id="pyams_security.plugin.social.SocialLoginConfigurationAdapter">
       
   330 <code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialLoginConfigurationAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginConfigurationAdapter" title="Permalink to this definition">¶</a></dt>
       
   331 <dd><p>Social login configuration adapter</p>
       
   332 </dd></dl>
       
   333 
       
   334 <dl class="class">
       
   335 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection">
       
   336 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialLoginProviderConnection</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection" title="Permalink to this definition">¶</a></dt>
       
   337 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
       
   338 <p>Social login provider connection</p>
       
   339 <dl class="attribute">
       
   340 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection.consumer_key">
       
   341 <code class="descname">consumer_key</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.consumer_key" title="Permalink to this definition">¶</a></dt>
       
   342 <dd><p>Computed attributes based on schema fields</p>
       
   343 <p>Field properties provide default values, data validation and error messages
       
   344 based on data found in field meta-data.</p>
       
   345 <p>Note that FieldProperties cannot be used with slots. They can only
       
   346 be used for attributes stored in instance dictionaries.</p>
       
   347 </dd></dl>
       
   348 
       
   349 <dl class="attribute">
       
   350 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection.consumer_secret">
       
   351 <code class="descname">consumer_secret</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.consumer_secret" title="Permalink to this definition">¶</a></dt>
       
   352 <dd><p>Computed attributes based on schema fields</p>
       
   353 <p>Field properties provide default values, data validation and error messages
       
   354 based on data found in field meta-data.</p>
       
   355 <p>Note that FieldProperties cannot be used with slots. They can only
       
   356 be used for attributes stored in instance dictionaries.</p>
       
   357 </dd></dl>
       
   358 
       
   359 <dl class="method">
       
   360 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection.get_configuration">
       
   361 <code class="descname">get_configuration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.get_configuration" title="Permalink to this definition">¶</a></dt>
       
   362 <dd></dd></dl>
       
   363 
       
   364 <dl class="attribute">
       
   365 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection.provider_id">
       
   366 <code class="descname">provider_id</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.provider_id" title="Permalink to this definition">¶</a></dt>
       
   367 <dd><p>Computed attributes based on schema fields</p>
       
   368 <p>Field properties provide default values, data validation and error messages
       
   369 based on data found in field meta-data.</p>
       
   370 <p>Note that FieldProperties cannot be used with slots. They can only
       
   371 be used for attributes stored in instance dictionaries.</p>
       
   372 </dd></dl>
       
   373 
       
   374 <dl class="attribute">
       
   375 <dt id="pyams_security.plugin.social.SocialLoginProviderConnection.provider_name">
       
   376 <code class="descname">provider_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.provider_name" title="Permalink to this definition">¶</a></dt>
       
   377 <dd><p>Computed attributes based on schema fields</p>
       
   378 <p>Field properties provide default values, data validation and error messages
       
   379 based on data found in field meta-data.</p>
       
   380 <p>Note that FieldProperties cannot be used with slots. They can only
       
   381 be used for attributes stored in instance dictionaries.</p>
       
   382 </dd></dl>
       
   383 
       
   384 </dd></dl>
       
   385 
       
   386 <dl class="class">
       
   387 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo">
       
   388 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialLoginProviderInfo</code><span class="sig-paren">(</span><em>name</em>, <em>provider</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo" title="Permalink to this definition">¶</a></dt>
       
   389 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   390 <p>Social login provider info</p>
       
   391 <dl class="attribute">
       
   392 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo.icon_class">
       
   393 <code class="descname">icon_class</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.icon_class" title="Permalink to this definition">¶</a></dt>
       
   394 <dd><p>Computed attributes based on schema fields</p>
       
   395 <p>Field properties provide default values, data validation and error messages
       
   396 based on data found in field meta-data.</p>
       
   397 <p>Note that FieldProperties cannot be used with slots. They can only
       
   398 be used for attributes stored in instance dictionaries.</p>
       
   399 </dd></dl>
       
   400 
       
   401 <dl class="attribute">
       
   402 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo.icon_filename">
       
   403 <code class="descname">icon_filename</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.icon_filename" title="Permalink to this definition">¶</a></dt>
       
   404 <dd><p>Computed attributes based on schema fields</p>
       
   405 <p>Field properties provide default values, data validation and error messages
       
   406 based on data found in field meta-data.</p>
       
   407 <p>Note that FieldProperties cannot be used with slots. They can only
       
   408 be used for attributes stored in instance dictionaries.</p>
       
   409 </dd></dl>
       
   410 
       
   411 <dl class="attribute">
       
   412 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo.name">
       
   413 <code class="descname">name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.name" title="Permalink to this definition">¶</a></dt>
       
   414 <dd><p>Computed attributes based on schema fields</p>
       
   415 <p>Field properties provide default values, data validation and error messages
       
   416 based on data found in field meta-data.</p>
       
   417 <p>Note that FieldProperties cannot be used with slots. They can only
       
   418 be used for attributes stored in instance dictionaries.</p>
       
   419 </dd></dl>
       
   420 
       
   421 <dl class="attribute">
       
   422 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo.provider">
       
   423 <code class="descname">provider</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.provider" title="Permalink to this definition">¶</a></dt>
       
   424 <dd></dd></dl>
       
   425 
       
   426 <dl class="attribute">
       
   427 <dt id="pyams_security.plugin.social.SocialLoginProviderInfo.scope">
       
   428 <code class="descname">scope</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.scope" title="Permalink to this definition">¶</a></dt>
       
   429 <dd><p>Computed attributes based on schema fields</p>
       
   430 <p>Field properties provide default values, data validation and error messages
       
   431 based on data found in field meta-data.</p>
       
   432 <p>Note that FieldProperties cannot be used with slots. They can only
       
   433 be used for attributes stored in instance dictionaries.</p>
       
   434 </dd></dl>
       
   435 
       
   436 </dd></dl>
       
   437 
       
   438 <dl class="class">
       
   439 <dt id="pyams_security.plugin.social.SocialUser">
       
   440 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialUser</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser" title="Permalink to this definition">¶</a></dt>
       
   441 <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>
       
   442 <p>Social user persistent class</p>
       
   443 <dl class="attribute">
       
   444 <dt id="pyams_security.plugin.social.SocialUser.birth_date">
       
   445 <code class="descname">birth_date</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.birth_date" title="Permalink to this definition">¶</a></dt>
       
   446 <dd><p>Computed attributes based on schema fields</p>
       
   447 <p>Field properties provide default values, data validation and error messages
       
   448 based on data found in field meta-data.</p>
       
   449 <p>Note that FieldProperties cannot be used with slots. They can only
       
   450 be used for attributes stored in instance dictionaries.</p>
       
   451 </dd></dl>
       
   452 
       
   453 <dl class="attribute">
       
   454 <dt id="pyams_security.plugin.social.SocialUser.city">
       
   455 <code class="descname">city</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.city" title="Permalink to this definition">¶</a></dt>
       
   456 <dd><p>Computed attributes based on schema fields</p>
       
   457 <p>Field properties provide default values, data validation and error messages
       
   458 based on data found in field meta-data.</p>
       
   459 <p>Note that FieldProperties cannot be used with slots. They can only
       
   460 be used for attributes stored in instance dictionaries.</p>
       
   461 </dd></dl>
       
   462 
       
   463 <dl class="attribute">
       
   464 <dt id="pyams_security.plugin.social.SocialUser.country">
       
   465 <code class="descname">country</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.country" title="Permalink to this definition">¶</a></dt>
       
   466 <dd><p>Computed attributes based on schema fields</p>
       
   467 <p>Field properties provide default values, data validation and error messages
       
   468 based on data found in field meta-data.</p>
       
   469 <p>Note that FieldProperties cannot be used with slots. They can only
       
   470 be used for attributes stored in instance dictionaries.</p>
       
   471 </dd></dl>
       
   472 
       
   473 <dl class="attribute">
       
   474 <dt id="pyams_security.plugin.social.SocialUser.email">
       
   475 <code class="descname">email</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.email" title="Permalink to this definition">¶</a></dt>
       
   476 <dd><p>Computed attributes based on schema fields</p>
       
   477 <p>Field properties provide default values, data validation and error messages
       
   478 based on data found in field meta-data.</p>
       
   479 <p>Note that FieldProperties cannot be used with slots. They can only
       
   480 be used for attributes stored in instance dictionaries.</p>
       
   481 </dd></dl>
       
   482 
       
   483 <dl class="attribute">
       
   484 <dt id="pyams_security.plugin.social.SocialUser.first_name">
       
   485 <code class="descname">first_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.first_name" title="Permalink to this definition">¶</a></dt>
       
   486 <dd><p>Computed attributes based on schema fields</p>
       
   487 <p>Field properties provide default values, data validation and error messages
       
   488 based on data found in field meta-data.</p>
       
   489 <p>Note that FieldProperties cannot be used with slots. They can only
       
   490 be used for attributes stored in instance dictionaries.</p>
       
   491 </dd></dl>
       
   492 
       
   493 <dl class="attribute">
       
   494 <dt id="pyams_security.plugin.social.SocialUser.last_name">
       
   495 <code class="descname">last_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.last_name" 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_security.plugin.social.SocialUser.locale">
       
   505 <code class="descname">locale</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.locale" 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_security.plugin.social.SocialUser.name">
       
   515 <code class="descname">name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.name" 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_security.plugin.social.SocialUser.nickname">
       
   525 <code class="descname">nickname</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.nickname" 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_security.plugin.social.SocialUser.picture">
       
   535 <code class="descname">picture</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.picture" 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 <dl class="attribute">
       
   544 <dt id="pyams_security.plugin.social.SocialUser.postal_code">
       
   545 <code class="descname">postal_code</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.postal_code" title="Permalink to this definition">¶</a></dt>
       
   546 <dd><p>Computed attributes based on schema fields</p>
       
   547 <p>Field properties provide default values, data validation and error messages
       
   548 based on data found in field meta-data.</p>
       
   549 <p>Note that FieldProperties cannot be used with slots. They can only
       
   550 be used for attributes stored in instance dictionaries.</p>
       
   551 </dd></dl>
       
   552 
       
   553 <dl class="attribute">
       
   554 <dt id="pyams_security.plugin.social.SocialUser.provider_name">
       
   555 <code class="descname">provider_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.provider_name" title="Permalink to this definition">¶</a></dt>
       
   556 <dd><p>Computed attributes based on schema fields</p>
       
   557 <p>Field properties provide default values, data validation and error messages
       
   558 based on data found in field meta-data.</p>
       
   559 <p>Note that FieldProperties cannot be used with slots. They can only
       
   560 be used for attributes stored in instance dictionaries.</p>
       
   561 </dd></dl>
       
   562 
       
   563 <dl class="attribute">
       
   564 <dt id="pyams_security.plugin.social.SocialUser.registration_date">
       
   565 <code class="descname">registration_date</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.registration_date" title="Permalink to this definition">¶</a></dt>
       
   566 <dd><p>Computed attributes based on schema fields</p>
       
   567 <p>Field properties provide default values, data validation and error messages
       
   568 based on data found in field meta-data.</p>
       
   569 <p>Note that FieldProperties cannot be used with slots. They can only
       
   570 be used for attributes stored in instance dictionaries.</p>
       
   571 </dd></dl>
       
   572 
       
   573 <dl class="attribute">
       
   574 <dt id="pyams_security.plugin.social.SocialUser.timezone">
       
   575 <code class="descname">timezone</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.timezone" title="Permalink to this definition">¶</a></dt>
       
   576 <dd><p>Computed attributes based on schema fields</p>
       
   577 <p>Field properties provide default values, data validation and error messages
       
   578 based on data found in field meta-data.</p>
       
   579 <p>Note that FieldProperties cannot be used with slots. They can only
       
   580 be used for attributes stored in instance dictionaries.</p>
       
   581 </dd></dl>
       
   582 
       
   583 <dl class="attribute">
       
   584 <dt id="pyams_security.plugin.social.SocialUser.title">
       
   585 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.title" title="Permalink to this definition">¶</a></dt>
       
   586 <dd></dd></dl>
       
   587 
       
   588 <dl class="attribute">
       
   589 <dt id="pyams_security.plugin.social.SocialUser.title_with_source">
       
   590 <code class="descname">title_with_source</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.title_with_source" title="Permalink to this definition">¶</a></dt>
       
   591 <dd></dd></dl>
       
   592 
       
   593 <dl class="attribute">
       
   594 <dt id="pyams_security.plugin.social.SocialUser.user_id">
       
   595 <code class="descname">user_id</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.user_id" title="Permalink to this definition">¶</a></dt>
       
   596 <dd><p>Computed attributes based on schema fields</p>
       
   597 <p>Field properties provide default values, data validation and error messages
       
   598 based on data found in field meta-data.</p>
       
   599 <p>Note that FieldProperties cannot be used with slots. They can only
       
   600 be used for attributes stored in instance dictionaries.</p>
       
   601 </dd></dl>
       
   602 
       
   603 <dl class="attribute">
       
   604 <dt id="pyams_security.plugin.social.SocialUser.username">
       
   605 <code class="descname">username</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.username" title="Permalink to this definition">¶</a></dt>
       
   606 <dd><p>Computed attributes based on schema fields</p>
       
   607 <p>Field properties provide default values, data validation and error messages
       
   608 based on data found in field meta-data.</p>
       
   609 <p>Note that FieldProperties cannot be used with slots. They can only
       
   610 be used for attributes stored in instance dictionaries.</p>
       
   611 </dd></dl>
       
   612 
       
   613 </dd></dl>
       
   614 
       
   615 <dl class="function">
       
   616 <dt id="pyams_security.plugin.social.SocialUserPrincipalInfoAdapter">
       
   617 <code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialUserPrincipalInfoAdapter</code><span class="sig-paren">(</span><em>user</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUserPrincipalInfoAdapter" title="Permalink to this definition">¶</a></dt>
       
   618 <dd><p>Social user principal info adapter</p>
       
   619 </dd></dl>
       
   620 
       
   621 <dl class="class">
       
   622 <dt id="pyams_security.plugin.social.SocialUsersFolder">
       
   623 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialUsersFolder</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder" title="Permalink to this definition">¶</a></dt>
       
   624 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   625 <p>Social users folder</p>
       
   626 <dl class="attribute">
       
   627 <dt id="pyams_security.plugin.social.SocialUsersFolder.enabled">
       
   628 <code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.enabled" title="Permalink to this definition">¶</a></dt>
       
   629 <dd><p>Computed attributes based on schema fields</p>
       
   630 <p>Field properties provide default values, data validation and error messages
       
   631 based on data found in field meta-data.</p>
       
   632 <p>Note that FieldProperties cannot be used with slots. They can only
       
   633 be used for attributes stored in instance dictionaries.</p>
       
   634 </dd></dl>
       
   635 
       
   636 <dl class="method">
       
   637 <dt id="pyams_security.plugin.social.SocialUsersFolder.find_principals">
       
   638 <code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.find_principals" title="Permalink to this definition">¶</a></dt>
       
   639 <dd></dd></dl>
       
   640 
       
   641 <dl class="method">
       
   642 <dt id="pyams_security.plugin.social.SocialUsersFolder.get_all_principals">
       
   643 <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_security.plugin.social.SocialUsersFolder.get_all_principals" title="Permalink to this definition">¶</a></dt>
       
   644 <dd></dd></dl>
       
   645 
       
   646 <dl class="method">
       
   647 <dt id="pyams_security.plugin.social.SocialUsersFolder.get_principal">
       
   648 <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_security.plugin.social.SocialUsersFolder.get_principal" title="Permalink to this definition">¶</a></dt>
       
   649 <dd></dd></dl>
       
   650 
       
   651 <dl class="method">
       
   652 <dt id="pyams_security.plugin.social.SocialUsersFolder.get_search_results">
       
   653 <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_security.plugin.social.SocialUsersFolder.get_search_results" title="Permalink to this definition">¶</a></dt>
       
   654 <dd></dd></dl>
       
   655 
       
   656 <dl class="attribute">
       
   657 <dt id="pyams_security.plugin.social.SocialUsersFolder.prefix">
       
   658 <code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.prefix" title="Permalink to this definition">¶</a></dt>
       
   659 <dd><p>Computed attributes based on schema fields</p>
       
   660 <p>Field properties provide default values, data validation and error messages
       
   661 based on data found in field meta-data.</p>
       
   662 <p>Note that FieldProperties cannot be used with slots. They can only
       
   663 be used for attributes stored in instance dictionaries.</p>
       
   664 </dd></dl>
       
   665 
       
   666 <dl class="attribute">
       
   667 <dt id="pyams_security.plugin.social.SocialUsersFolder.title">
       
   668 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.title" title="Permalink to this definition">¶</a></dt>
       
   669 <dd><p>Computed attributes based on schema fields</p>
       
   670 <p>Field properties provide default values, data validation and error messages
       
   671 based on data found in field meta-data.</p>
       
   672 <p>Note that FieldProperties cannot be used with slots. They can only
       
   673 be used for attributes stored in instance dictionaries.</p>
       
   674 </dd></dl>
       
   675 
       
   676 </dd></dl>
       
   677 
       
   678 <dl class="class">
       
   679 <dt id="pyams_security.plugin.social.SocialUsersFolderVocabulary">
       
   680 <em class="property">class </em><code class="descclassname">pyams_security.plugin.social.</code><code class="descname">SocialUsersFolderVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolderVocabulary" title="Permalink to this definition">¶</a></dt>
       
   681 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
       
   682 <p>‘PyAMS users folders’ vocabulary</p>
       
   683 </dd></dl>
       
   684 
       
   685 <dl class="function">
       
   686 <dt id="pyams_security.plugin.social.get_provider_info">
       
   687 <code class="descclassname">pyams_security.plugin.social.</code><code class="descname">get_provider_info</code><span class="sig-paren">(</span><em>provider_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.get_provider_info" title="Permalink to this definition">¶</a></dt>
       
   688 <dd><p>Get provider info matching given provider name</p>
       
   689 </dd></dl>
       
   690 
       
   691 <dl class="function">
       
   692 <dt id="pyams_security.plugin.social.handle_authenticated_principal">
       
   693 <code class="descclassname">pyams_security.plugin.social.</code><code class="descname">handle_authenticated_principal</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.handle_authenticated_principal" title="Permalink to this definition">¶</a></dt>
       
   694 <dd><p>Handle authenticated social principal</p>
       
   695 </dd></dl>
       
   696 
       
   697 </div>
       
   698 <div class="section" id="module-pyams_security.plugin.userfolder">
       
   699 <span id="pyams-security-plugin-userfolder-module"></span><h2>pyams_security.plugin.userfolder module<a class="headerlink" href="#module-pyams_security.plugin.userfolder" title="Permalink to this headline">¶</a></h2>
       
   700 <dl class="class">
       
   701 <dt id="pyams_security.plugin.userfolder.User">
       
   702 <em class="property">class </em><code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">User</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User" title="Permalink to this definition">¶</a></dt>
       
   703 <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>
       
   704 <p>Local user persistent class</p>
       
   705 <dl class="attribute">
       
   706 <dt id="pyams_security.plugin.userfolder.User.activated">
       
   707 <code class="descname">activated</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activated" title="Permalink to this definition">¶</a></dt>
       
   708 <dd><p>Computed attributes based on schema fields</p>
       
   709 <p>Field properties provide default values, data validation and error messages
       
   710 based on data found in field meta-data.</p>
       
   711 <p>Note that FieldProperties cannot be used with slots. They can only
       
   712 be used for attributes stored in instance dictionaries.</p>
       
   713 </dd></dl>
       
   714 
       
   715 <dl class="attribute">
       
   716 <dt id="pyams_security.plugin.userfolder.User.activation_date">
       
   717 <code class="descname">activation_date</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_date" title="Permalink to this definition">¶</a></dt>
       
   718 <dd><p>Computed attributes based on schema fields</p>
       
   719 <p>Field properties provide default values, data validation and error messages
       
   720 based on data found in field meta-data.</p>
       
   721 <p>Note that FieldProperties cannot be used with slots. They can only
       
   722 be used for attributes stored in instance dictionaries.</p>
       
   723 </dd></dl>
       
   724 
       
   725 <dl class="attribute">
       
   726 <dt id="pyams_security.plugin.userfolder.User.activation_hash">
       
   727 <code class="descname">activation_hash</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_hash" title="Permalink to this definition">¶</a></dt>
       
   728 <dd><p>Computed attributes based on schema fields</p>
       
   729 <p>Field properties provide default values, data validation and error messages
       
   730 based on data found in field meta-data.</p>
       
   731 <p>Note that FieldProperties cannot be used with slots. They can only
       
   732 be used for attributes stored in instance dictionaries.</p>
       
   733 </dd></dl>
       
   734 
       
   735 <dl class="attribute">
       
   736 <dt id="pyams_security.plugin.userfolder.User.activation_secret">
       
   737 <code class="descname">activation_secret</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_secret" title="Permalink to this definition">¶</a></dt>
       
   738 <dd><p>Computed attributes based on schema fields</p>
       
   739 <p>Field properties provide default values, data validation and error messages
       
   740 based on data found in field meta-data.</p>
       
   741 <p>Note that FieldProperties cannot be used with slots. They can only
       
   742 be used for attributes stored in instance dictionaries.</p>
       
   743 </dd></dl>
       
   744 
       
   745 <dl class="method">
       
   746 <dt id="pyams_security.plugin.userfolder.User.check_activation">
       
   747 <code class="descname">check_activation</code><span class="sig-paren">(</span><em>hash</em>, <em>login</em>, <em>password</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.User.check_activation" title="Permalink to this definition">¶</a></dt>
       
   748 <dd></dd></dl>
       
   749 
       
   750 <dl class="method">
       
   751 <dt id="pyams_security.plugin.userfolder.User.check_password">
       
   752 <code class="descname">check_password</code><span class="sig-paren">(</span><em>password</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.User.check_password" title="Permalink to this definition">¶</a></dt>
       
   753 <dd></dd></dl>
       
   754 
       
   755 <dl class="attribute">
       
   756 <dt id="pyams_security.plugin.userfolder.User.company_name">
       
   757 <code class="descname">company_name</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.company_name" title="Permalink to this definition">¶</a></dt>
       
   758 <dd><p>Computed attributes based on schema fields</p>
       
   759 <p>Field properties provide default values, data validation and error messages
       
   760 based on data found in field meta-data.</p>
       
   761 <p>Note that FieldProperties cannot be used with slots. They can only
       
   762 be used for attributes stored in instance dictionaries.</p>
       
   763 </dd></dl>
       
   764 
       
   765 <dl class="attribute">
       
   766 <dt id="pyams_security.plugin.userfolder.User.email">
       
   767 <code class="descname">email</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.email" title="Permalink to this definition">¶</a></dt>
       
   768 <dd><p>Computed attributes based on schema fields</p>
       
   769 <p>Field properties provide default values, data validation and error messages
       
   770 based on data found in field meta-data.</p>
       
   771 <p>Note that FieldProperties cannot be used with slots. They can only
       
   772 be used for attributes stored in instance dictionaries.</p>
       
   773 </dd></dl>
       
   774 
       
   775 <dl class="attribute">
       
   776 <dt id="pyams_security.plugin.userfolder.User.firstname">
       
   777 <code class="descname">firstname</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.firstname" title="Permalink to this definition">¶</a></dt>
       
   778 <dd><p>Computed attributes based on schema fields</p>
       
   779 <p>Field properties provide default values, data validation and error messages
       
   780 based on data found in field meta-data.</p>
       
   781 <p>Note that FieldProperties cannot be used with slots. They can only
       
   782 be used for attributes stored in instance dictionaries.</p>
       
   783 </dd></dl>
       
   784 
       
   785 <dl class="method">
       
   786 <dt id="pyams_security.plugin.userfolder.User.generate_secret">
       
   787 <code class="descname">generate_secret</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.User.generate_secret" title="Permalink to this definition">¶</a></dt>
       
   788 <dd></dd></dl>
       
   789 
       
   790 <dl class="attribute">
       
   791 <dt id="pyams_security.plugin.userfolder.User.lastname">
       
   792 <code class="descname">lastname</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.lastname" title="Permalink to this definition">¶</a></dt>
       
   793 <dd><p>Computed attributes based on schema fields</p>
       
   794 <p>Field properties provide default values, data validation and error messages
       
   795 based on data found in field meta-data.</p>
       
   796 <p>Note that FieldProperties cannot be used with slots. They can only
       
   797 be used for attributes stored in instance dictionaries.</p>
       
   798 </dd></dl>
       
   799 
       
   800 <dl class="attribute">
       
   801 <dt id="pyams_security.plugin.userfolder.User.login">
       
   802 <code class="descname">login</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.login" title="Permalink to this definition">¶</a></dt>
       
   803 <dd><p>Computed attributes based on schema fields</p>
       
   804 <p>Field properties provide default values, data validation and error messages
       
   805 based on data found in field meta-data.</p>
       
   806 <p>Note that FieldProperties cannot be used with slots. They can only
       
   807 be used for attributes stored in instance dictionaries.</p>
       
   808 </dd></dl>
       
   809 
       
   810 <dl class="attribute">
       
   811 <dt id="pyams_security.plugin.userfolder.User.password">
       
   812 <code class="descname">password</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.password" title="Permalink to this definition">¶</a></dt>
       
   813 <dd></dd></dl>
       
   814 
       
   815 <dl class="attribute">
       
   816 <dt id="pyams_security.plugin.userfolder.User.password_manager">
       
   817 <code class="descname">password_manager</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.password_manager" title="Permalink to this definition">¶</a></dt>
       
   818 <dd><p>Computed attributes based on schema fields</p>
       
   819 <p>Field properties provide default values, data validation and error messages
       
   820 based on data found in field meta-data.</p>
       
   821 <p>Note that FieldProperties cannot be used with slots. They can only
       
   822 be used for attributes stored in instance dictionaries.</p>
       
   823 </dd></dl>
       
   824 
       
   825 <dl class="attribute">
       
   826 <dt id="pyams_security.plugin.userfolder.User.self_registered">
       
   827 <code class="descname">self_registered</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.self_registered" title="Permalink to this definition">¶</a></dt>
       
   828 <dd><p>Computed attributes based on schema fields</p>
       
   829 <p>Field properties provide default values, data validation and error messages
       
   830 based on data found in field meta-data.</p>
       
   831 <p>Note that FieldProperties cannot be used with slots. They can only
       
   832 be used for attributes stored in instance dictionaries.</p>
       
   833 </dd></dl>
       
   834 
       
   835 <dl class="attribute">
       
   836 <dt id="pyams_security.plugin.userfolder.User.title">
       
   837 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.title" title="Permalink to this definition">¶</a></dt>
       
   838 <dd></dd></dl>
       
   839 
       
   840 <dl class="attribute">
       
   841 <dt id="pyams_security.plugin.userfolder.User.wait_confirmation">
       
   842 <code class="descname">wait_confirmation</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.wait_confirmation" title="Permalink to this definition">¶</a></dt>
       
   843 <dd><p>Computed attributes based on schema fields</p>
       
   844 <p>Field properties provide default values, data validation and error messages
       
   845 based on data found in field meta-data.</p>
       
   846 <p>Note that FieldProperties cannot be used with slots. They can only
       
   847 be used for attributes stored in instance dictionaries.</p>
       
   848 </dd></dl>
       
   849 
       
   850 </dd></dl>
       
   851 
       
   852 <dl class="function">
       
   853 <dt id="pyams_security.plugin.userfolder.UserPrincipalInfoAdapter">
       
   854 <code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">UserPrincipalInfoAdapter</code><span class="sig-paren">(</span><em>user</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UserPrincipalInfoAdapter" title="Permalink to this definition">¶</a></dt>
       
   855 <dd><p>User principal info adapter</p>
       
   856 </dd></dl>
       
   857 
       
   858 <dl class="class">
       
   859 <dt id="pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter">
       
   860 <em class="property">class </em><code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">UserPrincipalMailInfoAdapter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter" title="Permalink to this definition">¶</a></dt>
       
   861 <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>
       
   862 <p>User principal mail info adapter</p>
       
   863 <dl class="method">
       
   864 <dt id="pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter.get_addresses">
       
   865 <code class="descname">get_addresses</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter.get_addresses" title="Permalink to this definition">¶</a></dt>
       
   866 <dd></dd></dl>
       
   867 
       
   868 </dd></dl>
       
   869 
       
   870 <dl class="class">
       
   871 <dt id="pyams_security.plugin.userfolder.UsersFolder">
       
   872 <em class="property">class </em><code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">UsersFolder</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder" title="Permalink to this definition">¶</a></dt>
       
   873 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
       
   874 <p>Local users folder</p>
       
   875 <dl class="method">
       
   876 <dt id="pyams_security.plugin.userfolder.UsersFolder.authenticate">
       
   877 <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_security.plugin.userfolder.UsersFolder.authenticate" title="Permalink to this definition">¶</a></dt>
       
   878 <dd></dd></dl>
       
   879 
       
   880 <dl class="method">
       
   881 <dt id="pyams_security.plugin.userfolder.UsersFolder.check_login">
       
   882 <code class="descname">check_login</code><span class="sig-paren">(</span><em>login</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.check_login" title="Permalink to this definition">¶</a></dt>
       
   883 <dd></dd></dl>
       
   884 
       
   885 <dl class="attribute">
       
   886 <dt id="pyams_security.plugin.userfolder.UsersFolder.enabled">
       
   887 <code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.enabled" title="Permalink to this definition">¶</a></dt>
       
   888 <dd><p>Computed attributes based on schema fields</p>
       
   889 <p>Field properties provide default values, data validation and error messages
       
   890 based on data found in field meta-data.</p>
       
   891 <p>Note that FieldProperties cannot be used with slots. They can only
       
   892 be used for attributes stored in instance dictionaries.</p>
       
   893 </dd></dl>
       
   894 
       
   895 <dl class="method">
       
   896 <dt id="pyams_security.plugin.userfolder.UsersFolder.find_principals">
       
   897 <code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.find_principals" title="Permalink to this definition">¶</a></dt>
       
   898 <dd></dd></dl>
       
   899 
       
   900 <dl class="method">
       
   901 <dt id="pyams_security.plugin.userfolder.UsersFolder.get_all_principals">
       
   902 <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_security.plugin.userfolder.UsersFolder.get_all_principals" title="Permalink to this definition">¶</a></dt>
       
   903 <dd></dd></dl>
       
   904 
       
   905 <dl class="method">
       
   906 <dt id="pyams_security.plugin.userfolder.UsersFolder.get_principal">
       
   907 <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_security.plugin.userfolder.UsersFolder.get_principal" title="Permalink to this definition">¶</a></dt>
       
   908 <dd></dd></dl>
       
   909 
       
   910 <dl class="method">
       
   911 <dt id="pyams_security.plugin.userfolder.UsersFolder.get_search_results">
       
   912 <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_security.plugin.userfolder.UsersFolder.get_search_results" title="Permalink to this definition">¶</a></dt>
       
   913 <dd></dd></dl>
       
   914 
       
   915 <dl class="attribute">
       
   916 <dt id="pyams_security.plugin.userfolder.UsersFolder.prefix">
       
   917 <code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.prefix" title="Permalink to this definition">¶</a></dt>
       
   918 <dd><p>Computed attributes based on schema fields</p>
       
   919 <p>Field properties provide default values, data validation and error messages
       
   920 based on data found in field meta-data.</p>
       
   921 <p>Note that FieldProperties cannot be used with slots. They can only
       
   922 be used for attributes stored in instance dictionaries.</p>
       
   923 </dd></dl>
       
   924 
       
   925 <dl class="attribute">
       
   926 <dt id="pyams_security.plugin.userfolder.UsersFolder.title">
       
   927 <code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.title" title="Permalink to this definition">¶</a></dt>
       
   928 <dd><p>Computed attributes based on schema fields</p>
       
   929 <p>Field properties provide default values, data validation and error messages
       
   930 based on data found in field meta-data.</p>
       
   931 <p>Note that FieldProperties cannot be used with slots. They can only
       
   932 be used for attributes stored in instance dictionaries.</p>
       
   933 </dd></dl>
       
   934 
       
   935 </dd></dl>
       
   936 
       
   937 <dl class="class">
       
   938 <dt id="pyams_security.plugin.userfolder.UsersFolderVocabulary">
       
   939 <em class="property">class </em><code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">UsersFolderVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolderVocabulary" title="Permalink to this definition">¶</a></dt>
       
   940 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
       
   941 <p>‘PyAMS users folders’ vocabulary</p>
       
   942 </dd></dl>
       
   943 
       
   944 <dl class="function">
       
   945 <dt id="pyams_security.plugin.userfolder.handle_new_local_user">
       
   946 <code class="descclassname">pyams_security.plugin.userfolder.</code><code class="descname">handle_new_local_user</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.handle_new_local_user" title="Permalink to this definition">¶</a></dt>
       
   947 <dd><p>Send a confirmation message when a new user is recorded</p>
       
   948 </dd></dl>
       
   949 
       
   950 </div>
       
   951 <div class="section" id="module-pyams_security.plugin">
       
   952 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security.plugin" title="Permalink to this headline">¶</a></h2>
       
   953 <dl class="class">
       
   954 <dt id="pyams_security.plugin.PluginSelector">
       
   955 <em class="property">class </em><code class="descclassname">pyams_security.plugin.</code><code class="descname">PluginSelector</code><span class="sig-paren">(</span><em>name</em>, <em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.PluginSelector" title="Permalink to this definition">¶</a></dt>
       
   956 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   957 <p>Plug-in based event selector</p>
       
   958 <p>This selector can be used by subscriber to filter authentication
       
   959 events based on the name of the plug-in which fired the event.</p>
       
   960 <dl class="method">
       
   961 <dt id="pyams_security.plugin.PluginSelector.phash">
       
   962 <code class="descname">phash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.PluginSelector.phash" title="Permalink to this definition">¶</a></dt>
       
   963 <dd></dd></dl>
       
   964 
       
   965 <dl class="method">
       
   966 <dt id="pyams_security.plugin.PluginSelector.text">
       
   967 <code class="descname">text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.PluginSelector.text" title="Permalink to this definition">¶</a></dt>
       
   968 <dd></dd></dl>
       
   969 
       
   970 </dd></dl>
       
   971 
       
   972 </div>
       
   973 </div>
       
   974 
       
   975 
       
   976           </div>
       
   977         </div>
       
   978       </div>
       
   979       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
   980         <div class="sphinxsidebarwrapper">
       
   981   <h3><a href="index.html">Table Of Contents</a></h3>
       
   982   <ul>
       
   983 <li><a class="reference internal" href="#">pyams_security.plugin package</a><ul>
       
   984 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
   985 <li><a class="reference internal" href="#module-pyams_security.plugin.admin">pyams_security.plugin.admin module</a></li>
       
   986 <li><a class="reference internal" href="#module-pyams_security.plugin.group">pyams_security.plugin.group module</a></li>
       
   987 <li><a class="reference internal" href="#module-pyams_security.plugin.http">pyams_security.plugin.http module</a></li>
       
   988 <li><a class="reference internal" href="#module-pyams_security.plugin.social">pyams_security.plugin.social module</a></li>
       
   989 <li><a class="reference internal" href="#module-pyams_security.plugin.userfolder">pyams_security.plugin.userfolder module</a></li>
       
   990 <li><a class="reference internal" href="#module-pyams_security.plugin">Module contents</a></li>
       
   991 </ul>
       
   992 </li>
       
   993 </ul>
       
   994 
       
   995 <div id="searchbox" style="display: none" role="search">
       
   996   <h3>Quick search</h3>
       
   997     <form class="search" action="search.html" method="get">
       
   998       <div><input type="text" name="q" /></div>
       
   999       <div><input type="submit" value="Go" /></div>
       
  1000       <input type="hidden" name="check_keywords" value="yes" />
       
  1001       <input type="hidden" name="area" value="default" />
       
  1002     </form>
       
  1003 </div>
       
  1004 <script type="text/javascript">$('#searchbox').show(0);</script>
       
  1005         </div>
       
  1006       </div>
       
  1007       <div class="clearer"></div>
       
  1008     </div>
       
  1009     <div class="related" role="navigation" aria-label="related navigation">
       
  1010       <h3>Navigation</h3>
       
  1011       <ul>
       
  1012         <li class="right" style="margin-right: 10px">
       
  1013           <a href="genindex.html" title="General Index"
       
  1014              >index</a></li>
       
  1015         <li class="right" >
       
  1016           <a href="py-modindex.html" title="Python Module Index"
       
  1017              >modules</a> |</li>
       
  1018         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
  1019       </ul>
       
  1020     </div>
       
  1021     <div class="footer" role="contentinfo">
       
  1022         &#169; Copyright 2017, Thierry Florac.
       
  1023       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
       
  1024     </div>
       
  1025   </body>
       
  1026 </html>