|
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 — 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"> |
|
54 <span id="id1"></span><h1>PyAMS security<a class="headerlink" href="#pyams-security" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_security"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="function"> |
|
58 <dt id="pyams_security.includeme"> |
|
59 <code class="descclassname">pyams_security.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.includeme" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Pyramid include</p> |
|
61 <p>Split in another package to remove cyclic dependencies with TranslationStringFactory</p> |
|
62 </dd></dl> |
|
63 |
|
64 </div> |
|
65 <div class="section" id="subpackages"> |
|
66 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
67 <div class="toctree-wrapper compound"> |
|
68 <ul> |
|
69 <li class="toctree-l1"><a class="reference internal" href="pyams_security.interfaces.html">pyams_security.interfaces package</a><ul> |
|
70 <li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#submodules">Submodules</a></li> |
|
71 <li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces.notification">pyams_security.interfaces.notification module</a></li> |
|
72 <li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces.profile">pyams_security.interfaces.profile module</a></li> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces">Module contents</a></li> |
|
74 </ul> |
|
75 </li> |
|
76 <li class="toctree-l1"><a class="reference internal" href="pyams_security.plugin.html">pyams_security.plugin package</a><ul> |
|
77 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#submodules">Submodules</a></li> |
|
78 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.admin">pyams_security.plugin.admin module</a></li> |
|
79 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.group">pyams_security.plugin.group module</a></li> |
|
80 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.http">pyams_security.plugin.http module</a></li> |
|
81 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.social">pyams_security.plugin.social module</a></li> |
|
82 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.userfolder">pyams_security.plugin.userfolder module</a></li> |
|
83 <li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin">Module contents</a></li> |
|
84 </ul> |
|
85 </li> |
|
86 <li class="toctree-l1"><a class="reference internal" href="pyams_security.tests.html">pyams_security.tests package</a><ul> |
|
87 <li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#submodules">Submodules</a></li> |
|
88 <li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests.test_utilsdocs">pyams_security.tests.test_utilsdocs module</a></li> |
|
89 <li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests.test_utilsdocstrings">pyams_security.tests.test_utilsdocstrings module</a></li> |
|
90 <li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests">Module contents</a></li> |
|
91 </ul> |
|
92 </li> |
|
93 <li class="toctree-l1"><a class="reference internal" href="pyams_security.views.html">pyams_security.views package</a><ul> |
|
94 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#submodules">Submodules</a></li> |
|
95 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.login">pyams_security.views.login module</a></li> |
|
96 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.oauth">pyams_security.views.oauth module</a></li> |
|
97 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.userfolder">pyams_security.views.userfolder module</a></li> |
|
98 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.utility">pyams_security.views.utility module</a></li> |
|
99 <li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views">Module contents</a></li> |
|
100 </ul> |
|
101 </li> |
|
102 <li class="toctree-l1"><a class="reference internal" href="pyams_security.widget.html">pyams_security.widget package</a><ul> |
|
103 <li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#submodules">Submodules</a></li> |
|
104 <li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#module-pyams_security.widget.interfaces">pyams_security.widget.interfaces module</a></li> |
|
105 <li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#module-pyams_security.widget">Module contents</a></li> |
|
106 </ul> |
|
107 </li> |
|
108 <li class="toctree-l1"><a class="reference internal" href="pyams_security.zmi.html">pyams_security.zmi package</a><ul> |
|
109 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#subpackages">Subpackages</a><ul> |
|
110 <li class="toctree-l3"><a class="reference internal" href="pyams_security.zmi.plugin.html">pyams_security.zmi.plugin package</a><ul> |
|
111 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#submodules">Submodules</a></li> |
|
112 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.admin">pyams_security.zmi.plugin.admin module</a></li> |
|
113 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.group">pyams_security.zmi.plugin.group module</a></li> |
|
114 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.social">pyams_security.zmi.plugin.social module</a></li> |
|
115 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.userfolder">pyams_security.zmi.plugin.userfolder module</a></li> |
|
116 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin">Module contents</a></li> |
|
117 </ul> |
|
118 </li> |
|
119 <li class="toctree-l3"><a class="reference internal" href="pyams_security.zmi.widget.html">pyams_security.zmi.widget package</a><ul> |
|
120 <li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.widget.html#module-pyams_security.zmi.widget">Module contents</a></li> |
|
121 </ul> |
|
122 </li> |
|
123 </ul> |
|
124 </li> |
|
125 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#submodules">Submodules</a></li> |
|
126 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.interfaces">pyams_security.zmi.interfaces module</a></li> |
|
127 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.notification">pyams_security.zmi.notification module</a></li> |
|
128 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.profile">pyams_security.zmi.profile module</a></li> |
|
129 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.security">pyams_security.zmi.security module</a></li> |
|
130 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.utility">pyams_security.zmi.utility module</a></li> |
|
131 <li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi">Module contents</a></li> |
|
132 </ul> |
|
133 </li> |
|
134 </ul> |
|
135 </div> |
|
136 </div> |
|
137 <div class="section" id="submodules"> |
|
138 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
139 <div class="section" id="module-pyams_security.credential"> |
|
140 <span id="pyams-security-credential-module"></span><h3>pyams_security.credential module<a class="headerlink" href="#module-pyams_security.credential" title="Permalink to this headline">¶</a></h3> |
|
141 <dl class="class"> |
|
142 <dt id="pyams_security.credential.Credentials"> |
|
143 <em class="property">class </em><code class="descclassname">pyams_security.credential.</code><code class="descname">Credentials</code><span class="sig-paren">(</span><em>prefix</em>, <em>id</em>, <em>**attributes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.credential.Credentials" title="Permalink to this definition">¶</a></dt> |
|
144 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
145 <p>Credentials class</p> |
|
146 <dl class="attribute"> |
|
147 <dt id="pyams_security.credential.Credentials.attributes"> |
|
148 <code class="descname">attributes</code><a class="headerlink" href="#pyams_security.credential.Credentials.attributes" title="Permalink to this definition">¶</a></dt> |
|
149 <dd><p>Computed attributes based on schema fields</p> |
|
150 <p>Field properties provide default values, data validation and error messages |
|
151 based on data found in field meta-data.</p> |
|
152 <p>Note that FieldProperties cannot be used with slots. They can only |
|
153 be used for attributes stored in instance dictionaries.</p> |
|
154 </dd></dl> |
|
155 |
|
156 <dl class="attribute"> |
|
157 <dt id="pyams_security.credential.Credentials.id"> |
|
158 <code class="descname">id</code><a class="headerlink" href="#pyams_security.credential.Credentials.id" title="Permalink to this definition">¶</a></dt> |
|
159 <dd><p>Computed attributes based on schema fields</p> |
|
160 <p>Field properties provide default values, data validation and error messages |
|
161 based on data found in field meta-data.</p> |
|
162 <p>Note that FieldProperties cannot be used with slots. They can only |
|
163 be used for attributes stored in instance dictionaries.</p> |
|
164 </dd></dl> |
|
165 |
|
166 <dl class="attribute"> |
|
167 <dt id="pyams_security.credential.Credentials.prefix"> |
|
168 <code class="descname">prefix</code><a class="headerlink" href="#pyams_security.credential.Credentials.prefix" 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 </div> |
|
179 <div class="section" id="module-pyams_security.include"> |
|
180 <span id="pyams-security-include-module"></span><h3>pyams_security.include module<a class="headerlink" href="#module-pyams_security.include" title="Permalink to this headline">¶</a></h3> |
|
181 <dl class="function"> |
|
182 <dt id="pyams_security.include.include_package"> |
|
183 <code class="descclassname">pyams_security.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.include.include_package" title="Permalink to this definition">¶</a></dt> |
|
184 <dd><p>Pyramid include</p> |
|
185 </dd></dl> |
|
186 |
|
187 </div> |
|
188 <div class="section" id="module-pyams_security.index"> |
|
189 <span id="pyams-security-index-module"></span><h3>pyams_security.index module<a class="headerlink" href="#module-pyams_security.index" title="Permalink to this headline">¶</a></h3> |
|
190 <dl class="class"> |
|
191 <dt id="pyams_security.index.PrincipalsRoleIndex"> |
|
192 <em class="property">class </em><code class="descclassname">pyams_security.index.</code><code class="descname">PrincipalsRoleIndex</code><span class="sig-paren">(</span><em>role_id</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.index.PrincipalsRoleIndex" title="Permalink to this definition">¶</a></dt> |
|
193 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">hypatia.keyword.KeywordIndex</span></code></p> |
|
194 <p>Principals role index</p> |
|
195 <dl class="method"> |
|
196 <dt id="pyams_security.index.PrincipalsRoleIndex.discriminate"> |
|
197 <code class="descname">discriminate</code><span class="sig-paren">(</span><em>obj</em>, <em>default</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.index.PrincipalsRoleIndex.discriminate" title="Permalink to this definition">¶</a></dt> |
|
198 <dd></dd></dl> |
|
199 |
|
200 </dd></dl> |
|
201 |
|
202 </div> |
|
203 <div class="section" id="module-pyams_security.notification"> |
|
204 <span id="pyams-security-notification-module"></span><h3>pyams_security.notification module<a class="headerlink" href="#module-pyams_security.notification" title="Permalink to this headline">¶</a></h3> |
|
205 <dl class="class"> |
|
206 <dt id="pyams_security.notification.NotificationSettings"> |
|
207 <em class="property">class </em><code class="descclassname">pyams_security.notification.</code><code class="descname">NotificationSettings</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings" title="Permalink to this definition">¶</a></dt> |
|
208 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p> |
|
209 <p>Notification settings</p> |
|
210 <dl class="attribute"> |
|
211 <dt id="pyams_security.notification.NotificationSettings.enable_notifications"> |
|
212 <code class="descname">enable_notifications</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.enable_notifications" title="Permalink to this definition">¶</a></dt> |
|
213 <dd><p>Computed attributes based on schema fields</p> |
|
214 <p>Field properties provide default values, data validation and error messages |
|
215 based on data found in field meta-data.</p> |
|
216 <p>Note that FieldProperties cannot be used with slots. They can only |
|
217 be used for attributes stored in instance dictionaries.</p> |
|
218 </dd></dl> |
|
219 |
|
220 <dl class="attribute"> |
|
221 <dt id="pyams_security.notification.NotificationSettings.mailer"> |
|
222 <code class="descname">mailer</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.mailer" title="Permalink to this definition">¶</a></dt> |
|
223 <dd><p>Computed attributes based on schema fields</p> |
|
224 <p>Field properties provide default values, data validation and error messages |
|
225 based on data found in field meta-data.</p> |
|
226 <p>Note that FieldProperties cannot be used with slots. They can only |
|
227 be used for attributes stored in instance dictionaries.</p> |
|
228 </dd></dl> |
|
229 |
|
230 <dl class="attribute"> |
|
231 <dt id="pyams_security.notification.NotificationSettings.sender_email"> |
|
232 <code class="descname">sender_email</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.sender_email" title="Permalink to this definition">¶</a></dt> |
|
233 <dd><p>Computed attributes based on schema fields</p> |
|
234 <p>Field properties provide default values, data validation and error messages |
|
235 based on data found in field meta-data.</p> |
|
236 <p>Note that FieldProperties cannot be used with slots. They can only |
|
237 be used for attributes stored in instance dictionaries.</p> |
|
238 </dd></dl> |
|
239 |
|
240 <dl class="attribute"> |
|
241 <dt id="pyams_security.notification.NotificationSettings.sender_name"> |
|
242 <code class="descname">sender_name</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.sender_name" title="Permalink to this definition">¶</a></dt> |
|
243 <dd><p>Computed attributes based on schema fields</p> |
|
244 <p>Field properties provide default values, data validation and error messages |
|
245 based on data found in field meta-data.</p> |
|
246 <p>Note that FieldProperties cannot be used with slots. They can only |
|
247 be used for attributes stored in instance dictionaries.</p> |
|
248 </dd></dl> |
|
249 |
|
250 <dl class="attribute"> |
|
251 <dt id="pyams_security.notification.NotificationSettings.service_name"> |
|
252 <code class="descname">service_name</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.service_name" title="Permalink to this definition">¶</a></dt> |
|
253 <dd><p>Computed attributes based on schema fields</p> |
|
254 <p>Field properties provide default values, data validation and error messages |
|
255 based on data found in field meta-data.</p> |
|
256 <p>Note that FieldProperties cannot be used with slots. They can only |
|
257 be used for attributes stored in instance dictionaries.</p> |
|
258 </dd></dl> |
|
259 |
|
260 <dl class="attribute"> |
|
261 <dt id="pyams_security.notification.NotificationSettings.service_owner"> |
|
262 <code class="descname">service_owner</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.service_owner" title="Permalink to this definition">¶</a></dt> |
|
263 <dd><p>Computed attributes based on schema fields</p> |
|
264 <p>Field properties provide default values, data validation and error messages |
|
265 based on data found in field meta-data.</p> |
|
266 <p>Note that FieldProperties cannot be used with slots. They can only |
|
267 be used for attributes stored in instance dictionaries.</p> |
|
268 </dd></dl> |
|
269 |
|
270 <dl class="attribute"> |
|
271 <dt id="pyams_security.notification.NotificationSettings.signature"> |
|
272 <code class="descname">signature</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.signature" title="Permalink to this definition">¶</a></dt> |
|
273 <dd><p>Computed attributes based on schema fields</p> |
|
274 <p>Field properties provide default values, data validation and error messages |
|
275 based on data found in field meta-data.</p> |
|
276 <p>Note that FieldProperties cannot be used with slots. They can only |
|
277 be used for attributes stored in instance dictionaries.</p> |
|
278 </dd></dl> |
|
279 |
|
280 <dl class="attribute"> |
|
281 <dt id="pyams_security.notification.NotificationSettings.subject_prefix"> |
|
282 <code class="descname">subject_prefix</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.subject_prefix" title="Permalink to this definition">¶</a></dt> |
|
283 <dd><p>Computed attributes based on schema fields</p> |
|
284 <p>Field properties provide default values, data validation and error messages |
|
285 based on data found in field meta-data.</p> |
|
286 <p>Note that FieldProperties cannot be used with slots. They can only |
|
287 be used for attributes stored in instance dictionaries.</p> |
|
288 </dd></dl> |
|
289 |
|
290 </dd></dl> |
|
291 |
|
292 <dl class="function"> |
|
293 <dt id="pyams_security.notification.SecurityNotificationSettingsFactory"> |
|
294 <code class="descclassname">pyams_security.notification.</code><code class="descname">SecurityNotificationSettingsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.notification.SecurityNotificationSettingsFactory" title="Permalink to this definition">¶</a></dt> |
|
295 <dd><p>Security manager notifications factory adapter</p> |
|
296 </dd></dl> |
|
297 |
|
298 </div> |
|
299 <div class="section" id="module-pyams_security.permission"> |
|
300 <span id="pyams-security-permission-module"></span><h3>pyams_security.permission module<a class="headerlink" href="#module-pyams_security.permission" title="Permalink to this headline">¶</a></h3> |
|
301 <dl class="class"> |
|
302 <dt id="pyams_security.permission.Permission"> |
|
303 <em class="property">class </em><code class="descclassname">pyams_security.permission.</code><code class="descname">Permission</code><span class="sig-paren">(</span><em>values=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.Permission" title="Permalink to this definition">¶</a></dt> |
|
304 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
305 <p>Permission utility class</p> |
|
306 <dl class="attribute"> |
|
307 <dt id="pyams_security.permission.Permission.description"> |
|
308 <code class="descname">description</code><a class="headerlink" href="#pyams_security.permission.Permission.description" title="Permalink to this definition">¶</a></dt> |
|
309 <dd><p>Computed attributes based on schema fields</p> |
|
310 <p>Field properties provide default values, data validation and error messages |
|
311 based on data found in field meta-data.</p> |
|
312 <p>Note that FieldProperties cannot be used with slots. They can only |
|
313 be used for attributes stored in instance dictionaries.</p> |
|
314 </dd></dl> |
|
315 |
|
316 <dl class="attribute"> |
|
317 <dt id="pyams_security.permission.Permission.id"> |
|
318 <code class="descname">id</code><a class="headerlink" href="#pyams_security.permission.Permission.id" title="Permalink to this definition">¶</a></dt> |
|
319 <dd><p>Computed attributes based on schema fields</p> |
|
320 <p>Field properties provide default values, data validation and error messages |
|
321 based on data found in field meta-data.</p> |
|
322 <p>Note that FieldProperties cannot be used with slots. They can only |
|
323 be used for attributes stored in instance dictionaries.</p> |
|
324 </dd></dl> |
|
325 |
|
326 <dl class="attribute"> |
|
327 <dt id="pyams_security.permission.Permission.title"> |
|
328 <code class="descname">title</code><a class="headerlink" href="#pyams_security.permission.Permission.title" title="Permalink to this definition">¶</a></dt> |
|
329 <dd><p>Computed attributes based on schema fields</p> |
|
330 <p>Field properties provide default values, data validation and error messages |
|
331 based on data found in field meta-data.</p> |
|
332 <p>Note that FieldProperties cannot be used with slots. They can only |
|
333 be used for attributes stored in instance dictionaries.</p> |
|
334 </dd></dl> |
|
335 |
|
336 </dd></dl> |
|
337 |
|
338 <dl class="class"> |
|
339 <dt id="pyams_security.permission.PermissionsVocabulary"> |
|
340 <em class="property">class </em><code class="descclassname">pyams_security.permission.</code><code class="descname">PermissionsVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.PermissionsVocabulary" title="Permalink to this definition">¶</a></dt> |
|
341 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
342 <p>Permissions vocabulary</p> |
|
343 <dl class="attribute"> |
|
344 <dt id="pyams_security.permission.PermissionsVocabulary.interface"> |
|
345 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_security.interfaces.IPermission></em><a class="headerlink" href="#pyams_security.permission.PermissionsVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
346 <dd></dd></dl> |
|
347 |
|
348 </dd></dl> |
|
349 |
|
350 <dl class="function"> |
|
351 <dt id="pyams_security.permission.register_permission"> |
|
352 <code class="descclassname">pyams_security.permission.</code><code class="descname">register_permission</code><span class="sig-paren">(</span><em>config</em>, <em>permission</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.register_permission" title="Permalink to this definition">¶</a></dt> |
|
353 <dd><p>Register a new permission</p> |
|
354 <p>Permissions registry is not required. |
|
355 But only registered permissions can be applied via default |
|
356 ZMI features</p> |
|
357 </dd></dl> |
|
358 |
|
359 </div> |
|
360 <div class="section" id="module-pyams_security.principal"> |
|
361 <span id="pyams-security-principal-module"></span><h3>pyams_security.principal module<a class="headerlink" href="#module-pyams_security.principal" title="Permalink to this headline">¶</a></h3> |
|
362 <dl class="class"> |
|
363 <dt id="pyams_security.principal.MissingPrincipal"> |
|
364 <em class="property">class </em><code class="descclassname">pyams_security.principal.</code><code class="descname">MissingPrincipal</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.MissingPrincipal" title="Permalink to this definition">¶</a></dt> |
|
365 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
366 <p>Missing principal info</p> |
|
367 <p>This class can be used when a stored principal ID |
|
368 references a principal which can’t be found anymore</p> |
|
369 <dl class="attribute"> |
|
370 <dt id="pyams_security.principal.MissingPrincipal.id"> |
|
371 <code class="descname">id</code><a class="headerlink" href="#pyams_security.principal.MissingPrincipal.id" title="Permalink to this definition">¶</a></dt> |
|
372 <dd><p>Computed attributes based on schema fields</p> |
|
373 <p>Field properties provide default values, data validation and error messages |
|
374 based on data found in field meta-data.</p> |
|
375 <p>Note that FieldProperties cannot be used with slots. They can only |
|
376 be used for attributes stored in instance dictionaries.</p> |
|
377 </dd></dl> |
|
378 |
|
379 <dl class="attribute"> |
|
380 <dt id="pyams_security.principal.MissingPrincipal.title"> |
|
381 <code class="descname">title</code><a class="headerlink" href="#pyams_security.principal.MissingPrincipal.title" title="Permalink to this definition">¶</a></dt> |
|
382 <dd></dd></dl> |
|
383 |
|
384 </dd></dl> |
|
385 |
|
386 <dl class="class"> |
|
387 <dt id="pyams_security.principal.PrincipalInfo"> |
|
388 <em class="property">class </em><code class="descclassname">pyams_security.principal.</code><code class="descname">PrincipalInfo</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.PrincipalInfo" 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>Generic principal info</p> |
|
391 <dl class="attribute"> |
|
392 <dt id="pyams_security.principal.PrincipalInfo.attributes"> |
|
393 <code class="descname">attributes</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.attributes" 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.principal.PrincipalInfo.id"> |
|
403 <code class="descname">id</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.id" 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.principal.PrincipalInfo.title"> |
|
413 <code class="descname">title</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.title" 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 </dd></dl> |
|
422 |
|
423 <dl class="function"> |
|
424 <dt id="pyams_security.principal.get_principal_annotations"> |
|
425 <code class="descclassname">pyams_security.principal.</code><code class="descname">get_principal_annotations</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.get_principal_annotations" title="Permalink to this definition">¶</a></dt> |
|
426 <dd><p>Principal annotations adapter</p> |
|
427 </dd></dl> |
|
428 |
|
429 </div> |
|
430 <div class="section" id="module-pyams_security.profile"> |
|
431 <span id="pyams-security-profile-module"></span><h3>pyams_security.profile module<a class="headerlink" href="#module-pyams_security.profile" title="Permalink to this headline">¶</a></h3> |
|
432 <dl class="function"> |
|
433 <dt id="pyams_security.profile.PrincipalPublicProfileFactory"> |
|
434 <code class="descclassname">pyams_security.profile.</code><code class="descname">PrincipalPublicProfileFactory</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PrincipalPublicProfileFactory" title="Permalink to this definition">¶</a></dt> |
|
435 <dd><p>Principal public profile factory adapter</p> |
|
436 </dd></dl> |
|
437 |
|
438 <dl class="class"> |
|
439 <dt id="pyams_security.profile.ProfileTraverser"> |
|
440 <em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">ProfileTraverser</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.ProfileTraverser" title="Permalink to this definition">¶</a></dt> |
|
441 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextRequestAdapter" title="pyams_utils.adapter.ContextRequestAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextRequestAdapter</span></code></a></p> |
|
442 <p>++profile++ namespace traverser</p> |
|
443 <dl class="method"> |
|
444 <dt id="pyams_security.profile.ProfileTraverser.traverse"> |
|
445 <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.profile.ProfileTraverser.traverse" title="Permalink to this definition">¶</a></dt> |
|
446 <dd></dd></dl> |
|
447 |
|
448 </dd></dl> |
|
449 |
|
450 <dl class="class"> |
|
451 <dt id="pyams_security.profile.PublicProfile"> |
|
452 <em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfile</code><a class="headerlink" href="#pyams_security.profile.PublicProfile" title="Permalink to this definition">¶</a></dt> |
|
453 <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> |
|
454 <p>Public profile persistent class</p> |
|
455 <dl class="attribute"> |
|
456 <dt id="pyams_security.profile.PublicProfile.avatar"> |
|
457 <code class="descname">avatar</code><a class="headerlink" href="#pyams_security.profile.PublicProfile.avatar" title="Permalink to this definition">¶</a></dt> |
|
458 <dd><p>Property class used to handle files</p> |
|
459 </dd></dl> |
|
460 |
|
461 </dd></dl> |
|
462 |
|
463 <dl class="class"> |
|
464 <dt id="pyams_security.profile.PublicProfileExtension"> |
|
465 <em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfileExtension</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileExtension" title="Permalink to this definition">¶</a></dt> |
|
466 <dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextRequestAdapter" title="pyams_utils.adapter.ContextRequestAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextRequestAdapter</span></code></a></p> |
|
467 <p>public_profile TALES extension</p> |
|
468 <dl class="method"> |
|
469 <dt id="pyams_security.profile.PublicProfileExtension.render"> |
|
470 <code class="descname">render</code><span class="sig-paren">(</span><em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileExtension.render" title="Permalink to this definition">¶</a></dt> |
|
471 <dd></dd></dl> |
|
472 |
|
473 </dd></dl> |
|
474 |
|
475 <dl class="function"> |
|
476 <dt id="pyams_security.profile.PublicProfileFactory"> |
|
477 <code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfileFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileFactory" title="Permalink to this definition">¶</a></dt> |
|
478 <dd></dd></dl> |
|
479 |
|
480 </div> |
|
481 <div class="section" id="module-pyams_security.property"> |
|
482 <span id="pyams-security-property-module"></span><h3>pyams_security.property module<a class="headerlink" href="#module-pyams_security.property" title="Permalink to this headline">¶</a></h3> |
|
483 <dl class="class"> |
|
484 <dt id="pyams_security.property.RolePrincipalsFieldProperty"> |
|
485 <em class="property">class </em><code class="descclassname">pyams_security.property.</code><code class="descname">RolePrincipalsFieldProperty</code><span class="sig-paren">(</span><em>field</em>, <em>role_id=None</em>, <em>name=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.property.RolePrincipalsFieldProperty" title="Permalink to this definition">¶</a></dt> |
|
486 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
487 <p>Custom field property used to handle role principals</p> |
|
488 </dd></dl> |
|
489 |
|
490 </div> |
|
491 <div class="section" id="module-pyams_security.role"> |
|
492 <span id="pyams-security-role-module"></span><h3>pyams_security.role module<a class="headerlink" href="#module-pyams_security.role" title="Permalink to this headline">¶</a></h3> |
|
493 <dl class="class"> |
|
494 <dt id="pyams_security.role.Role"> |
|
495 <em class="property">class </em><code class="descclassname">pyams_security.role.</code><code class="descname">Role</code><span class="sig-paren">(</span><em>values=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.Role" title="Permalink to this definition">¶</a></dt> |
|
496 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
497 <p>Role utility class</p> |
|
498 <dl class="attribute"> |
|
499 <dt id="pyams_security.role.Role.description"> |
|
500 <code class="descname">description</code><a class="headerlink" href="#pyams_security.role.Role.description" title="Permalink to this definition">¶</a></dt> |
|
501 <dd><p>Computed attributes based on schema fields</p> |
|
502 <p>Field properties provide default values, data validation and error messages |
|
503 based on data found in field meta-data.</p> |
|
504 <p>Note that FieldProperties cannot be used with slots. They can only |
|
505 be used for attributes stored in instance dictionaries.</p> |
|
506 </dd></dl> |
|
507 |
|
508 <dl class="attribute"> |
|
509 <dt id="pyams_security.role.Role.id"> |
|
510 <code class="descname">id</code><a class="headerlink" href="#pyams_security.role.Role.id" title="Permalink to this definition">¶</a></dt> |
|
511 <dd><p>Computed attributes based on schema fields</p> |
|
512 <p>Field properties provide default values, data validation and error messages |
|
513 based on data found in field meta-data.</p> |
|
514 <p>Note that FieldProperties cannot be used with slots. They can only |
|
515 be used for attributes stored in instance dictionaries.</p> |
|
516 </dd></dl> |
|
517 |
|
518 <dl class="attribute"> |
|
519 <dt id="pyams_security.role.Role.managers"> |
|
520 <code class="descname">managers</code><a class="headerlink" href="#pyams_security.role.Role.managers" title="Permalink to this definition">¶</a></dt> |
|
521 <dd><p>Computed attributes based on schema fields</p> |
|
522 <p>Field properties provide default values, data validation and error messages |
|
523 based on data found in field meta-data.</p> |
|
524 <p>Note that FieldProperties cannot be used with slots. They can only |
|
525 be used for attributes stored in instance dictionaries.</p> |
|
526 </dd></dl> |
|
527 |
|
528 <dl class="attribute"> |
|
529 <dt id="pyams_security.role.Role.permissions"> |
|
530 <code class="descname">permissions</code><a class="headerlink" href="#pyams_security.role.Role.permissions" title="Permalink to this definition">¶</a></dt> |
|
531 <dd><p>Computed attributes based on schema fields</p> |
|
532 <p>Field properties provide default values, data validation and error messages |
|
533 based on data found in field meta-data.</p> |
|
534 <p>Note that FieldProperties cannot be used with slots. They can only |
|
535 be used for attributes stored in instance dictionaries.</p> |
|
536 </dd></dl> |
|
537 |
|
538 <dl class="attribute"> |
|
539 <dt id="pyams_security.role.Role.title"> |
|
540 <code class="descname">title</code><a class="headerlink" href="#pyams_security.role.Role.title" title="Permalink to this definition">¶</a></dt> |
|
541 <dd><p>Computed attributes based on schema fields</p> |
|
542 <p>Field properties provide default values, data validation and error messages |
|
543 based on data found in field meta-data.</p> |
|
544 <p>Note that FieldProperties cannot be used with slots. They can only |
|
545 be used for attributes stored in instance dictionaries.</p> |
|
546 </dd></dl> |
|
547 |
|
548 </dd></dl> |
|
549 |
|
550 <dl class="class"> |
|
551 <dt id="pyams_security.role.RolesVocabulary"> |
|
552 <em class="property">class </em><code class="descclassname">pyams_security.role.</code><code class="descname">RolesVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.RolesVocabulary" title="Permalink to this definition">¶</a></dt> |
|
553 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p> |
|
554 <p>Roles vocabulary</p> |
|
555 <dl class="attribute"> |
|
556 <dt id="pyams_security.role.RolesVocabulary.interface"> |
|
557 <code class="descname">interface</code><em class="property"> = <InterfaceClass pyams_security.interfaces.IRole></em><a class="headerlink" href="#pyams_security.role.RolesVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
558 <dd></dd></dl> |
|
559 |
|
560 </dd></dl> |
|
561 |
|
562 <dl class="function"> |
|
563 <dt id="pyams_security.role.register_role"> |
|
564 <code class="descclassname">pyams_security.role.</code><code class="descname">register_role</code><span class="sig-paren">(</span><em>config</em>, <em>role</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.register_role" title="Permalink to this definition">¶</a></dt> |
|
565 <dd><p>Register a new role</p> |
|
566 <p>Roles registry is not required. |
|
567 But only registered roles can be applied via default |
|
568 ZMI features.</p> |
|
569 <p>If a role is registered several times, previous registrations |
|
570 will just be updated to add new permissions. |
|
571 Title and description are not updated after first registration.</p> |
|
572 </dd></dl> |
|
573 |
|
574 </div> |
|
575 <div class="section" id="module-pyams_security.schema"> |
|
576 <span id="pyams-security-schema-module"></span><h3>pyams_security.schema module<a class="headerlink" href="#module-pyams_security.schema" title="Permalink to this headline">¶</a></h3> |
|
577 <dl class="class"> |
|
578 <dt id="pyams_security.schema.PermissionField"> |
|
579 <em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PermissionField</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PermissionField" title="Permalink to this definition">¶</a></dt> |
|
580 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Choice</span></code></p> |
|
581 <p>Permission field</p> |
|
582 </dd></dl> |
|
583 |
|
584 <dl class="class"> |
|
585 <dt id="pyams_security.schema.PermissionsSetField"> |
|
586 <em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PermissionsSetField</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PermissionsSetField" title="Permalink to this definition">¶</a></dt> |
|
587 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Set</span></code></p> |
|
588 <p>Permissions set field</p> |
|
589 </dd></dl> |
|
590 |
|
591 <dl class="class"> |
|
592 <dt id="pyams_security.schema.Principal"> |
|
593 <em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">Principal</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.Principal" title="Permalink to this definition">¶</a></dt> |
|
594 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._bootstrapfields.TextLine</span></code></p> |
|
595 <p>Principal field</p> |
|
596 <dl class="attribute"> |
|
597 <dt id="pyams_security.schema.Principal.role_id"> |
|
598 <code class="descname">role_id</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.schema.Principal.role_id" title="Permalink to this definition">¶</a></dt> |
|
599 <dd></dd></dl> |
|
600 |
|
601 </dd></dl> |
|
602 |
|
603 <dl class="class"> |
|
604 <dt id="pyams_security.schema.PrincipalsSet"> |
|
605 <em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PrincipalsSet</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PrincipalsSet" title="Permalink to this definition">¶</a></dt> |
|
606 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Set</span></code></p> |
|
607 <p>Principals set field</p> |
|
608 <dl class="attribute"> |
|
609 <dt id="pyams_security.schema.PrincipalsSet.role_id"> |
|
610 <code class="descname">role_id</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.schema.PrincipalsSet.role_id" title="Permalink to this definition">¶</a></dt> |
|
611 <dd></dd></dl> |
|
612 |
|
613 </dd></dl> |
|
614 |
|
615 </div> |
|
616 <div class="section" id="module-pyams_security.security"> |
|
617 <span id="pyams-security-security-module"></span><h3>pyams_security.security module<a class="headerlink" href="#module-pyams_security.security" title="Permalink to this headline">¶</a></h3> |
|
618 <dl class="class"> |
|
619 <dt id="pyams_security.security.ProtectedObject"> |
|
620 <em class="property">class </em><code class="descclassname">pyams_security.security.</code><code class="descname">ProtectedObject</code><a class="headerlink" href="#pyams_security.security.ProtectedObject" title="Permalink to this definition">¶</a></dt> |
|
621 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
622 <p>Base protected object class</p> |
|
623 </dd></dl> |
|
624 |
|
625 <dl class="function"> |
|
626 <dt id="pyams_security.security.ProtectedObjectFactory"> |
|
627 <code class="descclassname">pyams_security.security.</code><code class="descname">ProtectedObjectFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.ProtectedObjectFactory" title="Permalink to this definition">¶</a></dt> |
|
628 <dd><p>Default protected object factory</p> |
|
629 </dd></dl> |
|
630 |
|
631 <dl class="class"> |
|
632 <dt id="pyams_security.security.RoleProtectedObject"> |
|
633 <em class="property">class </em><code class="descclassname">pyams_security.security.</code><code class="descname">RoleProtectedObject</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject" title="Permalink to this definition">¶</a></dt> |
|
634 <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> |
|
635 <p>Base class for object protected by roles</p> |
|
636 <dl class="attribute"> |
|
637 <dt id="pyams_security.security.RoleProtectedObject.authenticated_denied"> |
|
638 <code class="descname">authenticated_denied</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.authenticated_denied" title="Permalink to this definition">¶</a></dt> |
|
639 <dd><p>Computed attributes based on schema fields</p> |
|
640 <p>Field properties provide default values, data validation and error messages |
|
641 based on data found in field meta-data.</p> |
|
642 <p>Note that FieldProperties cannot be used with slots. They can only |
|
643 be used for attributes stored in instance dictionaries.</p> |
|
644 </dd></dl> |
|
645 |
|
646 <dl class="attribute"> |
|
647 <dt id="pyams_security.security.RoleProtectedObject.authenticated_granted"> |
|
648 <code class="descname">authenticated_granted</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.authenticated_granted" title="Permalink to this definition">¶</a></dt> |
|
649 <dd><p>Computed attributes based on schema fields</p> |
|
650 <p>Field properties provide default values, data validation and error messages |
|
651 based on data found in field meta-data.</p> |
|
652 <p>Note that FieldProperties cannot be used with slots. They can only |
|
653 be used for attributes stored in instance dictionaries.</p> |
|
654 </dd></dl> |
|
655 |
|
656 <dl class="attribute"> |
|
657 <dt id="pyams_security.security.RoleProtectedObject.everyone_denied"> |
|
658 <code class="descname">everyone_denied</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.everyone_denied" 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.security.RoleProtectedObject.everyone_granted"> |
|
668 <code class="descname">everyone_granted</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.everyone_granted" 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 <dl class="method"> |
|
677 <dt id="pyams_security.security.RoleProtectedObject.get_authenticated_denied"> |
|
678 <code class="descname">get_authenticated_denied</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_authenticated_denied" title="Permalink to this definition">¶</a></dt> |
|
679 <dd></dd></dl> |
|
680 |
|
681 <dl class="method"> |
|
682 <dt id="pyams_security.security.RoleProtectedObject.get_authenticated_granted"> |
|
683 <code class="descname">get_authenticated_granted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_authenticated_granted" title="Permalink to this definition">¶</a></dt> |
|
684 <dd></dd></dl> |
|
685 |
|
686 <dl class="method"> |
|
687 <dt id="pyams_security.security.RoleProtectedObject.get_everyone_denied"> |
|
688 <code class="descname">get_everyone_denied</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_everyone_denied" title="Permalink to this definition">¶</a></dt> |
|
689 <dd></dd></dl> |
|
690 |
|
691 <dl class="method"> |
|
692 <dt id="pyams_security.security.RoleProtectedObject.get_everyone_granted"> |
|
693 <code class="descname">get_everyone_granted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_everyone_granted" title="Permalink to this definition">¶</a></dt> |
|
694 <dd></dd></dl> |
|
695 |
|
696 <dl class="method"> |
|
697 <dt id="pyams_security.security.RoleProtectedObject.get_granted_roles"> |
|
698 <code class="descname">get_granted_roles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_granted_roles" title="Permalink to this definition">¶</a></dt> |
|
699 <dd></dd></dl> |
|
700 |
|
701 <dl class="method"> |
|
702 <dt id="pyams_security.security.RoleProtectedObject.get_permissions"> |
|
703 <code class="descname">get_permissions</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_permissions" title="Permalink to this definition">¶</a></dt> |
|
704 <dd></dd></dl> |
|
705 |
|
706 <dl class="method"> |
|
707 <dt id="pyams_security.security.RoleProtectedObject.get_principals"> |
|
708 <code class="descname">get_principals</code><span class="sig-paren">(</span><em>role_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_principals" title="Permalink to this definition">¶</a></dt> |
|
709 <dd></dd></dl> |
|
710 |
|
711 <dl class="method"> |
|
712 <dt id="pyams_security.security.RoleProtectedObject.get_roles"> |
|
713 <code class="descname">get_roles</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_roles" title="Permalink to this definition">¶</a></dt> |
|
714 <dd></dd></dl> |
|
715 |
|
716 <dl class="method"> |
|
717 <dt id="pyams_security.security.RoleProtectedObject.grant_role"> |
|
718 <code class="descname">grant_role</code><span class="sig-paren">(</span><em>role_id</em>, <em>principal_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.grant_role" title="Permalink to this definition">¶</a></dt> |
|
719 <dd></dd></dl> |
|
720 |
|
721 <dl class="attribute"> |
|
722 <dt id="pyams_security.security.RoleProtectedObject.inherit_parent_roles"> |
|
723 <code class="descname">inherit_parent_roles</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.inherit_parent_roles" title="Permalink to this definition">¶</a></dt> |
|
724 <dd><p>Computed attributes based on schema fields</p> |
|
725 <p>Field properties provide default values, data validation and error messages |
|
726 based on data found in field meta-data.</p> |
|
727 <p>Note that FieldProperties cannot be used with slots. They can only |
|
728 be used for attributes stored in instance dictionaries.</p> |
|
729 </dd></dl> |
|
730 |
|
731 <dl class="attribute"> |
|
732 <dt id="pyams_security.security.RoleProtectedObject.inherit_parent_security"> |
|
733 <code class="descname">inherit_parent_security</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.inherit_parent_security" title="Permalink to this definition">¶</a></dt> |
|
734 <dd><p>Computed attributes based on schema fields</p> |
|
735 <p>Field properties provide default values, data validation and error messages |
|
736 based on data found in field meta-data.</p> |
|
737 <p>Note that FieldProperties cannot be used with slots. They can only |
|
738 be used for attributes stored in instance dictionaries.</p> |
|
739 </dd></dl> |
|
740 |
|
741 <dl class="method"> |
|
742 <dt id="pyams_security.security.RoleProtectedObject.revoke_role"> |
|
743 <code class="descname">revoke_role</code><span class="sig-paren">(</span><em>role_id</em>, <em>principal_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.revoke_role" title="Permalink to this definition">¶</a></dt> |
|
744 <dd></dd></dl> |
|
745 |
|
746 </dd></dl> |
|
747 |
|
748 </div> |
|
749 <div class="section" id="module-pyams_security.site"> |
|
750 <span id="pyams-security-site-module"></span><h3>pyams_security.site module<a class="headerlink" href="#module-pyams_security.site" title="Permalink to this headline">¶</a></h3> |
|
751 <dl class="class"> |
|
752 <dt id="pyams_security.site.SecurityGenerationsChecker"> |
|
753 <em class="property">class </em><code class="descclassname">pyams_security.site.</code><code class="descname">SecurityGenerationsChecker</code><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker" title="Permalink to this definition">¶</a></dt> |
|
754 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
755 <p>I18n generations checker</p> |
|
756 <dl class="method"> |
|
757 <dt id="pyams_security.site.SecurityGenerationsChecker.evolve"> |
|
758 <code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt> |
|
759 <dd><p>Check for required utilities</p> |
|
760 </dd></dl> |
|
761 |
|
762 <dl class="attribute"> |
|
763 <dt id="pyams_security.site.SecurityGenerationsChecker.generation"> |
|
764 <code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt> |
|
765 <dd></dd></dl> |
|
766 |
|
767 </dd></dl> |
|
768 |
|
769 <dl class="function"> |
|
770 <dt id="pyams_security.site.get_admin_user"> |
|
771 <code class="descclassname">pyams_security.site.</code><code class="descname">get_admin_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.get_admin_user" title="Permalink to this definition">¶</a></dt> |
|
772 <dd><p>Get system manager profile</p> |
|
773 </dd></dl> |
|
774 |
|
775 <dl class="function"> |
|
776 <dt id="pyams_security.site.get_service_user"> |
|
777 <code class="descclassname">pyams_security.site.</code><code class="descname">get_service_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.get_service_user" title="Permalink to this definition">¶</a></dt> |
|
778 <dd><p>Get internal services profile</p> |
|
779 </dd></dl> |
|
780 |
|
781 <dl class="function"> |
|
782 <dt id="pyams_security.site.handle_new_local_site"> |
|
783 <code class="descclassname">pyams_security.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt> |
|
784 <dd><p>Create a new security manager when a site is created</p> |
|
785 </dd></dl> |
|
786 |
|
787 <dl class="function"> |
|
788 <dt id="pyams_security.site.handle_new_security_manager"> |
|
789 <code class="descclassname">pyams_security.site.</code><code class="descname">handle_new_security_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.handle_new_security_manager" title="Permalink to this definition">¶</a></dt> |
|
790 <dd><p>Automatically create a new administration login</p> |
|
791 </dd></dl> |
|
792 |
|
793 </div> |
|
794 <div class="section" id="module-pyams_security.utility"> |
|
795 <span id="pyams-security-utility-module"></span><h3>pyams_security.utility module<a class="headerlink" href="#module-pyams_security.utility" title="Permalink to this headline">¶</a></h3> |
|
796 <dl class="class"> |
|
797 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy"> |
|
798 <em class="property">class </em><code class="descclassname">pyams_security.utility.</code><code class="descname">PyAMSAuthenticationPolicy</code><span class="sig-paren">(</span><em>secret</em>, <em>credentials=('http'</em>, <em>)</em>, <em>cookie_name='auth_ticket'</em>, <em>secure=False</em>, <em>include_ip=False</em>, <em>timeout=None</em>, <em>reissue_time=None</em>, <em>max_age=None</em>, <em>path='/'</em>, <em>http_only=False</em>, <em>wild_domain=True</em>, <em>hashalg='sha256'</em>, <em>parent_domain=False</em>, <em>domain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy" title="Permalink to this definition">¶</a></dt> |
|
799 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
800 <p>PyAMS authentication policy</p> |
|
801 <p>This authentication policy relies on a registered ISecurityManager utility. |
|
802 Use same authentication ticket as AuthTktAuthenticationPolicy.</p> |
|
803 <p><code class="docutils literal"><span class="pre">credentials</span></code> is the list of credentials extraction utilities which can be |
|
804 used to get credentials.</p> |
|
805 <p>See <cite>pyramid.authentication.AuthTktAuthenticationPolicy</cite> to get description |
|
806 of other constructor arguments.</p> |
|
807 <dl class="method"> |
|
808 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.authenticated_userid"> |
|
809 <code class="descname">authenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.authenticated_userid" title="Permalink to this definition">¶</a></dt> |
|
810 <dd></dd></dl> |
|
811 |
|
812 <dl class="attribute"> |
|
813 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.credentials_plugins"> |
|
814 <code class="descname">credentials_plugins</code><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.credentials_plugins" title="Permalink to this definition">¶</a></dt> |
|
815 <dd></dd></dl> |
|
816 |
|
817 <dl class="method"> |
|
818 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.effective_principals"> |
|
819 <code class="descname">effective_principals</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.effective_principals" title="Permalink to this definition">¶</a></dt> |
|
820 <dd></dd></dl> |
|
821 |
|
822 <dl class="method"> |
|
823 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.forget"> |
|
824 <code class="descname">forget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.forget" title="Permalink to this definition">¶</a></dt> |
|
825 <dd></dd></dl> |
|
826 |
|
827 <dl class="method"> |
|
828 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.remember"> |
|
829 <code class="descname">remember</code><span class="sig-paren">(</span><em>request</em>, <em>principal</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.remember" title="Permalink to this definition">¶</a></dt> |
|
830 <dd></dd></dl> |
|
831 |
|
832 <dl class="method"> |
|
833 <dt id="pyams_security.utility.PyAMSAuthenticationPolicy.unauthenticated_userid"> |
|
834 <code class="descname">unauthenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.unauthenticated_userid" title="Permalink to this definition">¶</a></dt> |
|
835 <dd></dd></dl> |
|
836 |
|
837 </dd></dl> |
|
838 |
|
839 <dl class="class"> |
|
840 <dt id="pyams_security.utility.SecurityManager"> |
|
841 <em class="property">class </em><code class="descclassname">pyams_security.utility.</code><code class="descname">SecurityManager</code><a class="headerlink" href="#pyams_security.utility.SecurityManager" title="Permalink to this definition">¶</a></dt> |
|
842 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p> |
|
843 <p>Security manager utility</p> |
|
844 <dl class="method"> |
|
845 <dt id="pyams_security.utility.SecurityManager.authenticate"> |
|
846 <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.utility.SecurityManager.authenticate" title="Permalink to this definition">¶</a></dt> |
|
847 <dd></dd></dl> |
|
848 |
|
849 <dl class="method"> |
|
850 <dt id="pyams_security.utility.SecurityManager.authenticated_userid"> |
|
851 <code class="descname">authenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.authenticated_userid" title="Permalink to this definition">¶</a></dt> |
|
852 <dd></dd></dl> |
|
853 |
|
854 <dl class="attribute"> |
|
855 <dt id="pyams_security.utility.SecurityManager.authentication_plugins_names"> |
|
856 <code class="descname">authentication_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.authentication_plugins_names" title="Permalink to this definition">¶</a></dt> |
|
857 <dd><p>Computed attributes based on schema fields</p> |
|
858 <p>Field properties provide default values, data validation and error messages |
|
859 based on data found in field meta-data.</p> |
|
860 <p>Note that FieldProperties cannot be used with slots. They can only |
|
861 be used for attributes stored in instance dictionaries.</p> |
|
862 </dd></dl> |
|
863 |
|
864 <dl class="attribute"> |
|
865 <dt id="pyams_security.utility.SecurityManager.authomatic_secret"> |
|
866 <code class="descname">authomatic_secret</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.authomatic_secret" title="Permalink to this definition">¶</a></dt> |
|
867 <dd><p>Computed attributes based on schema fields</p> |
|
868 <p>Field properties provide default values, data validation and error messages |
|
869 based on data found in field meta-data.</p> |
|
870 <p>Note that FieldProperties cannot be used with slots. They can only |
|
871 be used for attributes stored in instance dictionaries.</p> |
|
872 </dd></dl> |
|
873 |
|
874 <dl class="attribute"> |
|
875 <dt id="pyams_security.utility.SecurityManager.credentials_plugins_names"> |
|
876 <code class="descname">credentials_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.credentials_plugins_names" title="Permalink to this definition">¶</a></dt> |
|
877 <dd></dd></dl> |
|
878 |
|
879 <dl class="attribute"> |
|
880 <dt id="pyams_security.utility.SecurityManager.directory_plugins_names"> |
|
881 <code class="descname">directory_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.directory_plugins_names" title="Permalink to this definition">¶</a></dt> |
|
882 <dd><p>Computed attributes based on schema fields</p> |
|
883 <p>Field properties provide default values, data validation and error messages |
|
884 based on data found in field meta-data.</p> |
|
885 <p>Note that FieldProperties cannot be used with slots. They can only |
|
886 be used for attributes stored in instance dictionaries.</p> |
|
887 </dd></dl> |
|
888 |
|
889 <dl class="method"> |
|
890 <dt id="pyams_security.utility.SecurityManager.effective_principals"> |
|
891 <code class="descname">effective_principals</code><span class="sig-paren">(</span><em>principal_id</em>, <em>request=None</em>, <em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.effective_principals" title="Permalink to this definition">¶</a></dt> |
|
892 <dd></dd></dl> |
|
893 |
|
894 <dl class="attribute"> |
|
895 <dt id="pyams_security.utility.SecurityManager.enable_social_login"> |
|
896 <code class="descname">enable_social_login</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.enable_social_login" title="Permalink to this definition">¶</a></dt> |
|
897 <dd><p>Computed attributes based on schema fields</p> |
|
898 <p>Field properties provide default values, data validation and error messages |
|
899 based on data found in field meta-data.</p> |
|
900 <p>Note that FieldProperties cannot be used with slots. They can only |
|
901 be used for attributes stored in instance dictionaries.</p> |
|
902 </dd></dl> |
|
903 |
|
904 <dl class="method"> |
|
905 <dt id="pyams_security.utility.SecurityManager.extract_credentials"> |
|
906 <code class="descname">extract_credentials</code><span class="sig-paren">(</span><em>request</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.extract_credentials" title="Permalink to this definition">¶</a></dt> |
|
907 <dd></dd></dl> |
|
908 |
|
909 <dl class="method"> |
|
910 <dt id="pyams_security.utility.SecurityManager.find_principals"> |
|
911 <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.utility.SecurityManager.find_principals" title="Permalink to this definition">¶</a></dt> |
|
912 <dd></dd></dl> |
|
913 |
|
914 <dl class="method"> |
|
915 <dt id="pyams_security.utility.SecurityManager.get_all_principals"> |
|
916 <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.utility.SecurityManager.get_all_principals" title="Permalink to this definition">¶</a></dt> |
|
917 <dd></dd></dl> |
|
918 |
|
919 <dl class="method"> |
|
920 <dt id="pyams_security.utility.SecurityManager.get_authentication_plugins"> |
|
921 <code class="descname">get_authentication_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_authentication_plugins" title="Permalink to this definition">¶</a></dt> |
|
922 <dd></dd></dl> |
|
923 |
|
924 <dl class="method"> |
|
925 <dt id="pyams_security.utility.SecurityManager.get_credentials_plugins"> |
|
926 <code class="descname">get_credentials_plugins</code><span class="sig-paren">(</span><em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_credentials_plugins" title="Permalink to this definition">¶</a></dt> |
|
927 <dd></dd></dl> |
|
928 |
|
929 <dl class="method"> |
|
930 <dt id="pyams_security.utility.SecurityManager.get_directory_plugins"> |
|
931 <code class="descname">get_directory_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_directory_plugins" title="Permalink to this definition">¶</a></dt> |
|
932 <dd></dd></dl> |
|
933 |
|
934 <dl class="method"> |
|
935 <dt id="pyams_security.utility.SecurityManager.get_groups_directory_plugins"> |
|
936 <code class="descname">get_groups_directory_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_groups_directory_plugins" title="Permalink to this definition">¶</a></dt> |
|
937 <dd></dd></dl> |
|
938 |
|
939 <dl class="method"> |
|
940 <dt id="pyams_security.utility.SecurityManager.get_plugin"> |
|
941 <code class="descname">get_plugin</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_plugin" title="Permalink to this definition">¶</a></dt> |
|
942 <dd></dd></dl> |
|
943 |
|
944 <dl class="attribute"> |
|
945 <dt id="pyams_security.utility.SecurityManager.get_principal"> |
|
946 <code class="descname">get_principal</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_principal" title="Permalink to this definition">¶</a></dt> |
|
947 <dd></dd></dl> |
|
948 |
|
949 <dl class="attribute"> |
|
950 <dt id="pyams_security.utility.SecurityManager.open_registration"> |
|
951 <code class="descname">open_registration</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.open_registration" title="Permalink to this definition">¶</a></dt> |
|
952 <dd><p>Computed attributes based on schema fields</p> |
|
953 <p>Field properties provide default values, data validation and error messages |
|
954 based on data found in field meta-data.</p> |
|
955 <p>Note that FieldProperties cannot be used with slots. They can only |
|
956 be used for attributes stored in instance dictionaries.</p> |
|
957 </dd></dl> |
|
958 |
|
959 <dl class="attribute"> |
|
960 <dt id="pyams_security.utility.SecurityManager.social_login_use_popup"> |
|
961 <code class="descname">social_login_use_popup</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.social_login_use_popup" title="Permalink to this definition">¶</a></dt> |
|
962 <dd><p>Computed attributes based on schema fields</p> |
|
963 <p>Field properties provide default values, data validation and error messages |
|
964 based on data found in field meta-data.</p> |
|
965 <p>Note that FieldProperties cannot be used with slots. They can only |
|
966 be used for attributes stored in instance dictionaries.</p> |
|
967 </dd></dl> |
|
968 |
|
969 <dl class="attribute"> |
|
970 <dt id="pyams_security.utility.SecurityManager.social_users_folder"> |
|
971 <code class="descname">social_users_folder</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.social_users_folder" title="Permalink to this definition">¶</a></dt> |
|
972 <dd><p>Computed attributes based on schema fields</p> |
|
973 <p>Field properties provide default values, data validation and error messages |
|
974 based on data found in field meta-data.</p> |
|
975 <p>Note that FieldProperties cannot be used with slots. They can only |
|
976 be used for attributes stored in instance dictionaries.</p> |
|
977 </dd></dl> |
|
978 |
|
979 <dl class="attribute"> |
|
980 <dt id="pyams_security.utility.SecurityManager.users_folder"> |
|
981 <code class="descname">users_folder</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.users_folder" title="Permalink to this definition">¶</a></dt> |
|
982 <dd><p>Computed attributes based on schema fields</p> |
|
983 <p>Field properties provide default values, data validation and error messages |
|
984 based on data found in field meta-data.</p> |
|
985 <p>Note that FieldProperties cannot be used with slots. They can only |
|
986 be used for attributes stored in instance dictionaries.</p> |
|
987 </dd></dl> |
|
988 |
|
989 </dd></dl> |
|
990 |
|
991 <dl class="function"> |
|
992 <dt id="pyams_security.utility.get_principal"> |
|
993 <code class="descclassname">pyams_security.utility.</code><code class="descname">get_principal</code><span class="sig-paren">(</span><em>request</em>, <em>principal_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.get_principal" title="Permalink to this definition">¶</a></dt> |
|
994 <dd><p>Get principal associated with given request</p> |
|
995 </dd></dl> |
|
996 |
|
997 </div> |
|
998 <div class="section" id="module-pyams_security.vocabulary"> |
|
999 <span id="pyams-security-vocabulary-module"></span><h3>pyams_security.vocabulary module<a class="headerlink" href="#module-pyams_security.vocabulary" title="Permalink to this headline">¶</a></h3> |
|
1000 <dl class="class"> |
|
1001 <dt id="pyams_security.vocabulary.PasswordManagerVocabulary"> |
|
1002 <em class="property">class </em><code class="descclassname">pyams_security.vocabulary.</code><code class="descname">PasswordManagerVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary" title="Permalink to this definition">¶</a></dt> |
|
1003 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p> |
|
1004 <p>Password managers vocabulary</p> |
|
1005 <dl class="attribute"> |
|
1006 <dt id="pyams_security.vocabulary.PasswordManagerVocabulary.interface"> |
|
1007 <code class="descname">interface</code><em class="property"> = <InterfaceClass zope.password.interfaces.IPasswordManager></em><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary.interface" title="Permalink to this definition">¶</a></dt> |
|
1008 <dd></dd></dl> |
|
1009 |
|
1010 <dl class="attribute"> |
|
1011 <dt id="pyams_security.vocabulary.PasswordManagerVocabulary.nameOnly"> |
|
1012 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt> |
|
1013 <dd></dd></dl> |
|
1014 |
|
1015 </dd></dl> |
|
1016 |
|
1017 </div> |
|
1018 </div> |
|
1019 </div> |
|
1020 |
|
1021 |
|
1022 </div> |
|
1023 </div> |
|
1024 </div> |
|
1025 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
1026 <div class="sphinxsidebarwrapper"> |
|
1027 <h3><a href="index.html">Table Of Contents</a></h3> |
|
1028 <ul> |
|
1029 <li><a class="reference internal" href="#">PyAMS security</a><ul> |
|
1030 <li><a class="reference internal" href="#module-pyams_security">Module contents</a></li> |
|
1031 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
1032 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
1033 <li><a class="reference internal" href="#module-pyams_security.credential">pyams_security.credential module</a></li> |
|
1034 <li><a class="reference internal" href="#module-pyams_security.include">pyams_security.include module</a></li> |
|
1035 <li><a class="reference internal" href="#module-pyams_security.index">pyams_security.index module</a></li> |
|
1036 <li><a class="reference internal" href="#module-pyams_security.notification">pyams_security.notification module</a></li> |
|
1037 <li><a class="reference internal" href="#module-pyams_security.permission">pyams_security.permission module</a></li> |
|
1038 <li><a class="reference internal" href="#module-pyams_security.principal">pyams_security.principal module</a></li> |
|
1039 <li><a class="reference internal" href="#module-pyams_security.profile">pyams_security.profile module</a></li> |
|
1040 <li><a class="reference internal" href="#module-pyams_security.property">pyams_security.property module</a></li> |
|
1041 <li><a class="reference internal" href="#module-pyams_security.role">pyams_security.role module</a></li> |
|
1042 <li><a class="reference internal" href="#module-pyams_security.schema">pyams_security.schema module</a></li> |
|
1043 <li><a class="reference internal" href="#module-pyams_security.security">pyams_security.security module</a></li> |
|
1044 <li><a class="reference internal" href="#module-pyams_security.site">pyams_security.site module</a></li> |
|
1045 <li><a class="reference internal" href="#module-pyams_security.utility">pyams_security.utility module</a></li> |
|
1046 <li><a class="reference internal" href="#module-pyams_security.vocabulary">pyams_security.vocabulary module</a></li> |
|
1047 </ul> |
|
1048 </li> |
|
1049 </ul> |
|
1050 </li> |
|
1051 </ul> |
|
1052 |
|
1053 <div id="searchbox" style="display: none" role="search"> |
|
1054 <h3>Quick search</h3> |
|
1055 <form class="search" action="search.html" method="get"> |
|
1056 <div><input type="text" name="q" /></div> |
|
1057 <div><input type="submit" value="Go" /></div> |
|
1058 <input type="hidden" name="check_keywords" value="yes" /> |
|
1059 <input type="hidden" name="area" value="default" /> |
|
1060 </form> |
|
1061 </div> |
|
1062 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
1063 </div> |
|
1064 </div> |
|
1065 <div class="clearer"></div> |
|
1066 </div> |
|
1067 <div class="related" role="navigation" aria-label="related navigation"> |
|
1068 <h3>Navigation</h3> |
|
1069 <ul> |
|
1070 <li class="right" style="margin-right: 10px"> |
|
1071 <a href="genindex.html" title="General Index" |
|
1072 >index</a></li> |
|
1073 <li class="right" > |
|
1074 <a href="py-modindex.html" title="Python Module Index" |
|
1075 >modules</a> |</li> |
|
1076 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
1077 </ul> |
|
1078 </div> |
|
1079 <div class="footer" role="contentinfo"> |
|
1080 © Copyright 2017, Thierry Florac. |
|
1081 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
1082 </div> |
|
1083 </body> |
|
1084 </html> |