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.interfaces package — 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&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&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> »</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-interfaces-package"> |
|
54 <h1>pyams_security.interfaces package<a class="headerlink" href="#pyams-security-interfaces-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.interfaces.notification"> |
|
59 <span id="pyams-security-interfaces-notification-module"></span><h2>pyams_security.interfaces.notification module<a class="headerlink" href="#module-pyams_security.interfaces.notification" title="Permalink to this headline">¶</a></h2> |
|
60 </div> |
|
61 <div class="section" id="module-pyams_security.interfaces.profile"> |
|
62 <span id="pyams-security-interfaces-profile-module"></span><h2>pyams_security.interfaces.profile module<a class="headerlink" href="#module-pyams_security.interfaces.profile" title="Permalink to this headline">¶</a></h2> |
|
63 </div> |
|
64 <div class="section" id="module-pyams_security.interfaces"> |
|
65 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security.interfaces" title="Permalink to this headline">¶</a></h2> |
|
66 <dl class="class"> |
|
67 <dt id="pyams_security.interfaces.AuthenticatedPrincipalEvent"> |
|
68 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">AuthenticatedPrincipalEvent</code><span class="sig-paren">(</span><em>plugin</em>, <em>principal_id</em>, <em>**infos</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.AuthenticatedPrincipalEvent" title="Permalink to this definition">¶</a></dt> |
|
69 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
70 <p>Authenticated principal event</p> |
|
71 </dd></dl> |
|
72 |
|
73 <dl class="class"> |
|
74 <dt id="pyams_security.interfaces.GrantedRoleEvent"> |
|
75 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">GrantedRoleEvent</code><span class="sig-paren">(</span><em>object</em>, <em>role_id</em>, <em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.GrantedRoleEvent" title="Permalink to this definition">¶</a></dt> |
|
76 <dd><p>Bases: <a class="reference internal" href="#pyams_security.interfaces.RoleEvent" title="pyams_security.interfaces.RoleEvent"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.interfaces.RoleEvent</span></code></a></p> |
|
77 <p>Granted role event</p> |
|
78 </dd></dl> |
|
79 |
|
80 <dl class="class"> |
|
81 <dt id="pyams_security.interfaces.PrincipalsAddedToGroupEvent"> |
|
82 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">PrincipalsAddedToGroupEvent</code><span class="sig-paren">(</span><em>group</em>, <em>principals</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.PrincipalsAddedToGroupEvent" title="Permalink to this definition">¶</a></dt> |
|
83 <dd><p>Bases: <a class="reference internal" href="#pyams_security.interfaces.PrincipalsGroupEvent" title="pyams_security.interfaces.PrincipalsGroupEvent"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.interfaces.PrincipalsGroupEvent</span></code></a></p> |
|
84 <p>Event fired when principals were added to group</p> |
|
85 </dd></dl> |
|
86 |
|
87 <dl class="class"> |
|
88 <dt id="pyams_security.interfaces.PrincipalsGroupEvent"> |
|
89 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">PrincipalsGroupEvent</code><span class="sig-paren">(</span><em>group</em>, <em>principals</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.PrincipalsGroupEvent" title="Permalink to this definition">¶</a></dt> |
|
90 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
91 <p>Principals group event</p> |
|
92 </dd></dl> |
|
93 |
|
94 <dl class="class"> |
|
95 <dt id="pyams_security.interfaces.PrincipalsRemovedFromGroupEvent"> |
|
96 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">PrincipalsRemovedFromGroupEvent</code><span class="sig-paren">(</span><em>group</em>, <em>principals</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.PrincipalsRemovedFromGroupEvent" title="Permalink to this definition">¶</a></dt> |
|
97 <dd><p>Bases: <a class="reference internal" href="#pyams_security.interfaces.PrincipalsGroupEvent" title="pyams_security.interfaces.PrincipalsGroupEvent"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.interfaces.PrincipalsGroupEvent</span></code></a></p> |
|
98 <p>Event fired when principals were removed from group</p> |
|
99 </dd></dl> |
|
100 |
|
101 <dl class="class"> |
|
102 <dt id="pyams_security.interfaces.RevokedRoleEvent"> |
|
103 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">RevokedRoleEvent</code><span class="sig-paren">(</span><em>object</em>, <em>role_id</em>, <em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.RevokedRoleEvent" title="Permalink to this definition">¶</a></dt> |
|
104 <dd><p>Bases: <a class="reference internal" href="#pyams_security.interfaces.RoleEvent" title="pyams_security.interfaces.RoleEvent"><code class="xref py py-class docutils literal"><span class="pre">pyams_security.interfaces.RoleEvent</span></code></a></p> |
|
105 <p>Revoked role interface</p> |
|
106 </dd></dl> |
|
107 |
|
108 <dl class="class"> |
|
109 <dt id="pyams_security.interfaces.RoleEvent"> |
|
110 <em class="property">class </em><code class="descclassname">pyams_security.interfaces.</code><code class="descname">RoleEvent</code><span class="sig-paren">(</span><em>object</em>, <em>role_id</em>, <em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.interfaces.RoleEvent" title="Permalink to this definition">¶</a></dt> |
|
111 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.interface.interfaces.ObjectEvent</span></code></p> |
|
112 <p>Base role event</p> |
|
113 </dd></dl> |
|
114 |
|
115 <dl class="function"> |
|
116 <dt id="pyams_security.interfaces.check_password"> |
|
117 <code class="descclassname">pyams_security.interfaces.</code><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.interfaces.check_password" title="Permalink to this definition">¶</a></dt> |
|
118 <dd><p>Check validity of a given password</p> |
|
119 </dd></dl> |
|
120 |
|
121 </div> |
|
122 </div> |
|
123 |
|
124 |
|
125 </div> |
|
126 </div> |
|
127 </div> |
|
128 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
129 <div class="sphinxsidebarwrapper"> |
|
130 <h3><a href="index.html">Table Of Contents</a></h3> |
|
131 <ul> |
|
132 <li><a class="reference internal" href="#">pyams_security.interfaces package</a><ul> |
|
133 <li><a class="reference internal" href="#submodules">Submodules</a></li> |
|
134 <li><a class="reference internal" href="#module-pyams_security.interfaces.notification">pyams_security.interfaces.notification module</a></li> |
|
135 <li><a class="reference internal" href="#module-pyams_security.interfaces.profile">pyams_security.interfaces.profile module</a></li> |
|
136 <li><a class="reference internal" href="#module-pyams_security.interfaces">Module contents</a></li> |
|
137 </ul> |
|
138 </li> |
|
139 </ul> |
|
140 |
|
141 <div id="searchbox" style="display: none" role="search"> |
|
142 <h3>Quick search</h3> |
|
143 <form class="search" action="search.html" method="get"> |
|
144 <div><input type="text" name="q" /></div> |
|
145 <div><input type="submit" value="Go" /></div> |
|
146 <input type="hidden" name="check_keywords" value="yes" /> |
|
147 <input type="hidden" name="area" value="default" /> |
|
148 </form> |
|
149 </div> |
|
150 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
151 </div> |
|
152 </div> |
|
153 <div class="clearer"></div> |
|
154 </div> |
|
155 <div class="related" role="navigation" aria-label="related navigation"> |
|
156 <h3>Navigation</h3> |
|
157 <ul> |
|
158 <li class="right" style="margin-right: 10px"> |
|
159 <a href="genindex.html" title="General Index" |
|
160 >index</a></li> |
|
161 <li class="right" > |
|
162 <a href="py-modindex.html" title="Python Module Index" |
|
163 >modules</a> |</li> |
|
164 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
165 </ul> |
|
166 </div> |
|
167 <div class="footer" role="contentinfo"> |
|
168 © Copyright 2017, Thierry Florac. |
|
169 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
170 </div> |
|
171 </body> |
|
172 </html> |
|