--- a/src/build/html/pyams_security.plugin.html Mon Jan 15 16:45:01 2018 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,1026 +0,0 @@
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>pyams_security.plugin package — PyAMS User Guide 0.1.0 documentation</title>
- <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
- VERSION: '0.1.0',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
- SOURCELINK_SUFFIX: '.txt'
- };
- </script>
- <script type="text/javascript" src="_static/jquery.js"></script>
- <script type="text/javascript" src="_static/underscore.js"></script>
- <script type="text/javascript" src="_static/doctools.js"></script>
- <link rel="index" title="Index" href="genindex.html" />
- <link rel="search" title="Search" href="search.html" />
-<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" />
-<!--[if lte IE 6]>
-<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
-<![endif]-->
-
- </head>
- <body>
-
- <div class="related" role="navigation" aria-label="related navigation">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="genindex.html" title="General Index"
- accesskey="I">index</a></li>
- <li class="right" >
- <a href="py-modindex.html" title="Python Module Index"
- >modules</a> |</li>
- <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
- </ul>
- </div>
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <div class="section" id="pyams-security-plugin-package">
-<h1>pyams_security.plugin package<a class="headerlink" href="#pyams-security-plugin-package" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="submodules">
-<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
-</div>
-<div class="section" id="module-pyams_security.plugin.admin">
-<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>
-<dl class="class">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
-<p>Hard-coded administrator authenticator plug-in</p>
-<p>This plug-in should only be enabled in development mode!!!</p>
-<dl class="method">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.authenticate">
-<code class="descname">authenticate</code><span class="sig-paren">(</span><em>credentials</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.authenticate" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.enabled">
-<code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.enabled" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.find_principals">
-<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.find_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.get_all_principals">
-<code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.get_all_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.get_principal">
-<code class="descname">get_principal</code><span class="sig-paren">(</span><em>principal_id</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.get_principal" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.login">
-<code class="descname">login</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.login" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.password">
-<code class="descname">password</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.password" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.prefix">
-<code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.prefix" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.admin.AdminAuthenticationPlugin.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.admin.AdminAuthenticationPlugin.title" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-</div>
-<div class="section" id="module-pyams_security.plugin.group">
-<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>
-<dl class="class">
-<dt id="pyams_security.plugin.group.Group">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
-<p>Local group persistent class</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.Group.description">
-<code class="descname">description</code><a class="headerlink" href="#pyams_security.plugin.group.Group.description" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.Group.group_id">
-<code class="descname">group_id</code><a class="headerlink" href="#pyams_security.plugin.group.Group.group_id" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.Group.principals">
-<code class="descname">principals</code><a class="headerlink" href="#pyams_security.plugin.group.Group.principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.Group.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.group.Group.title" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.group.GroupsFolder">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
-<p>Principals groups folder</p>
-<dl class="method">
-<dt id="pyams_security.plugin.group.GroupsFolder.check_group_id">
-<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>
-<dd><p>Check for existence of given group ID</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.GroupsFolder.enabled">
-<code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.enabled" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.group.GroupsFolder.find_principals">
-<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.find_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.group.GroupsFolder.get_all_principals">
-<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>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.group.GroupsFolder.get_principal">
-<code class="descname">get_principal</code><span class="sig-paren">(</span><em>principal_id</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.get_principal" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.GroupsFolder.prefix">
-<code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.prefix" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.group.GroupsFolder.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.group.GroupsFolder.title" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.group.LocalGroupsVocabulary">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
-<p>‘PyAMS local groups vocabulary</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.group.handle_added_group">
-<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>
-<dd><p>Handle added group</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.group.handle_added_principals">
-<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>
-<dd><p>Handle principals added to group</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.group.handle_removed_principals">
-<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>
-<dd><p>Handle principals removed from group</p>
-</dd></dl>
-
-</div>
-<div class="section" id="module-pyams_security.plugin.http">
-<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>
-<dl class="class">
-<dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>HTTP basic credentials plug-in</p>
-<p>This credential plug-in is mainly used by automation processes using
-XML-RPC or JSON-RPC requests launched from batch scripts.</p>
-<p>Copied from pyramid_httpauth package.</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.enabled">
-<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>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.extract_credentials">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.prefix">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.http.HttpBasicCredentialsPlugin.title">
-<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>
-<dd></dd></dl>
-
-</dd></dl>
-
-</div>
-<div class="section" id="module-pyams_security.plugin.social">
-<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>
-<dl class="class">
-<dt id="pyams_security.plugin.social.OAuthProvidersVocabulary">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
-<p>OAuth providers vocabulary</p>
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SecurityManagerSocialTraverser">
-<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>
-<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
-<p>++social-configuration++ namespace traverser</p>
-<dl class="method">
-<dt id="pyams_security.plugin.social.SecurityManagerSocialTraverser.traverse">
-<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>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialLoginConfiguration">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
-<p>Social login configuration</p>
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialLoginConfiguration.get_oauth_configuration">
-<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>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.social.SocialLoginConfigurationAdapter">
-<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>
-<dd><p>Social login configuration adapter</p>
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
-<p>Social login provider connection</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection.consumer_key">
-<code class="descname">consumer_key</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.consumer_key" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection.consumer_secret">
-<code class="descname">consumer_secret</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.consumer_secret" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection.get_configuration">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection.provider_id">
-<code class="descname">provider_id</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.provider_id" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderConnection.provider_name">
-<code class="descname">provider_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderConnection.provider_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>Social login provider info</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo.icon_class">
-<code class="descname">icon_class</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.icon_class" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo.icon_filename">
-<code class="descname">icon_filename</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.icon_filename" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo.name">
-<code class="descname">name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo.provider">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialLoginProviderInfo.scope">
-<code class="descname">scope</code><a class="headerlink" href="#pyams_security.plugin.social.SocialLoginProviderInfo.scope" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialUser">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
-<p>Social user persistent class</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.birth_date">
-<code class="descname">birth_date</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.birth_date" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.city">
-<code class="descname">city</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.city" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.country">
-<code class="descname">country</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.country" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.email">
-<code class="descname">email</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.email" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.first_name">
-<code class="descname">first_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.first_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.last_name">
-<code class="descname">last_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.last_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.locale">
-<code class="descname">locale</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.locale" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.name">
-<code class="descname">name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.nickname">
-<code class="descname">nickname</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.nickname" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.picture">
-<code class="descname">picture</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.picture" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.postal_code">
-<code class="descname">postal_code</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.postal_code" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.provider_name">
-<code class="descname">provider_name</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.provider_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.registration_date">
-<code class="descname">registration_date</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.registration_date" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.timezone">
-<code class="descname">timezone</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.timezone" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.title" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.title_with_source">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.user_id">
-<code class="descname">user_id</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.user_id" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUser.username">
-<code class="descname">username</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUser.username" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.social.SocialUserPrincipalInfoAdapter">
-<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>
-<dd><p>Social user principal info adapter</p>
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialUsersFolder">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
-<p>Social users folder</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.enabled">
-<code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.enabled" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.find_principals">
-<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.find_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.get_all_principals">
-<code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.get_all_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.get_principal">
-<code class="descname">get_principal</code><span class="sig-paren">(</span><em>principal_id</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.get_principal" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.get_search_results">
-<code class="descname">get_search_results</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.get_search_results" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.prefix">
-<code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.prefix" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.social.SocialUsersFolder.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.social.SocialUsersFolder.title" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.social.SocialUsersFolderVocabulary">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
-<p>‘PyAMS users folders’ vocabulary</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.social.get_provider_info">
-<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>
-<dd><p>Get provider info matching given provider name</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.social.handle_authenticated_principal">
-<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>
-<dd><p>Handle authenticated social principal</p>
-</dd></dl>
-
-</div>
-<div class="section" id="module-pyams_security.plugin.userfolder">
-<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>
-<dl class="class">
-<dt id="pyams_security.plugin.userfolder.User">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
-<p>Local user persistent class</p>
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.activated">
-<code class="descname">activated</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activated" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.activation_date">
-<code class="descname">activation_date</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_date" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.activation_hash">
-<code class="descname">activation_hash</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_hash" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.activation_secret">
-<code class="descname">activation_secret</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.activation_secret" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.User.check_activation">
-<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>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.User.check_password">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.company_name">
-<code class="descname">company_name</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.company_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.email">
-<code class="descname">email</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.email" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.firstname">
-<code class="descname">firstname</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.firstname" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.User.generate_secret">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.lastname">
-<code class="descname">lastname</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.lastname" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.login">
-<code class="descname">login</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.login" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.password">
-<code class="descname">password</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.password" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.password_manager">
-<code class="descname">password_manager</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.password_manager" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.self_registered">
-<code class="descname">self_registered</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.self_registered" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.title" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.User.wait_confirmation">
-<code class="descname">wait_confirmation</code><a class="headerlink" href="#pyams_security.plugin.userfolder.User.wait_confirmation" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.userfolder.UserPrincipalInfoAdapter">
-<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>
-<dd><p>User principal info adapter</p>
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter">
-<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>
-<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextAdapter" title="pyams_utils.adapter.ContextAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextAdapter</span></code></a></p>
-<p>User principal mail info adapter</p>
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UserPrincipalMailInfoAdapter.get_addresses">
-<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>
-<dd></dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.userfolder.UsersFolder">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
-<p>Local users folder</p>
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.authenticate">
-<code class="descname">authenticate</code><span class="sig-paren">(</span><em>credentials</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.authenticate" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.check_login">
-<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>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.enabled">
-<code class="descname">enabled</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.enabled" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.find_principals">
-<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.find_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.get_all_principals">
-<code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.get_all_principals" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.get_principal">
-<code class="descname">get_principal</code><span class="sig-paren">(</span><em>principal_id</em>, <em>info=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.get_principal" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.get_search_results">
-<code class="descname">get_search_results</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.get_search_results" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.prefix">
-<code class="descname">prefix</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.prefix" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="pyams_security.plugin.userfolder.UsersFolder.title">
-<code class="descname">title</code><a class="headerlink" href="#pyams_security.plugin.userfolder.UsersFolder.title" title="Permalink to this definition">¶</a></dt>
-<dd><p>Computed attributes based on schema fields</p>
-<p>Field properties provide default values, data validation and error messages
-based on data found in field meta-data.</p>
-<p>Note that FieldProperties cannot be used with slots. They can only
-be used for attributes stored in instance dictionaries.</p>
-</dd></dl>
-
-</dd></dl>
-
-<dl class="class">
-<dt id="pyams_security.plugin.userfolder.UsersFolderVocabulary">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
-<p>‘PyAMS users folders’ vocabulary</p>
-</dd></dl>
-
-<dl class="function">
-<dt id="pyams_security.plugin.userfolder.handle_new_local_user">
-<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>
-<dd><p>Send a confirmation message when a new user is recorded</p>
-</dd></dl>
-
-</div>
-<div class="section" id="module-pyams_security.plugin">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security.plugin" title="Permalink to this headline">¶</a></h2>
-<dl class="class">
-<dt id="pyams_security.plugin.PluginSelector">
-<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>
-<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>Plug-in based event selector</p>
-<p>This selector can be used by subscriber to filter authentication
-events based on the name of the plug-in which fired the event.</p>
-<dl class="method">
-<dt id="pyams_security.plugin.PluginSelector.phash">
-<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>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="pyams_security.plugin.PluginSelector.text">
-<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>
-<dd></dd></dl>
-
-</dd></dl>
-
-</div>
-</div>
-
-
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
- <h3><a href="index.html">Table Of Contents</a></h3>
- <ul>
-<li><a class="reference internal" href="#">pyams_security.plugin package</a><ul>
-<li><a class="reference internal" href="#submodules">Submodules</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin.admin">pyams_security.plugin.admin module</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin.group">pyams_security.plugin.group module</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin.http">pyams_security.plugin.http module</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin.social">pyams_security.plugin.social module</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin.userfolder">pyams_security.plugin.userfolder module</a></li>
-<li><a class="reference internal" href="#module-pyams_security.plugin">Module contents</a></li>
-</ul>
-</li>
-</ul>
-
-<div id="searchbox" style="display: none" role="search">
- <h3>Quick search</h3>
- <form class="search" action="search.html" method="get">
- <div><input type="text" name="q" /></div>
- <div><input type="submit" value="Go" /></div>
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
- </div>
- </div>
- <div class="clearer"></div>
- </div>
- <div class="related" role="navigation" aria-label="related navigation">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="genindex.html" title="General Index"
- >index</a></li>
- <li class="right" >
- <a href="py-modindex.html" title="Python Module Index"
- >modules</a> |</li>
- <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li>
- </ul>
- </div>
- <div class="footer" role="contentinfo">
- © Copyright 2017, Thierry Florac.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
- </div>
- </body>
-</html>
\ No newline at end of file