Source

eggDiscover / documentation / build / social_auth.html

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The User Social Auth Module &mdash; EggDiscover 0.1 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="EggDiscover 0.1 documentation" href="index.html" />
    <link rel="up" title="External apps used in this project" href="externalapps.html" />
    <link rel="next" title="The Django Celery Module" href="djcelery.html" />
    <link rel="prev" title="External apps used in this project" href="externalapps.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="djcelery.html" title="The Django Celery Module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="externalapps.html" title="External apps used in this project"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">EggDiscover 0.1 documentation</a> &raquo;</li>
          <li><a href="externalapps.html" accesskey="U">External apps used in this project</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-social_auth">
<span id="the-user-social-auth-module"></span><h1>The User Social Auth Module<a class="headerlink" href="#module-social_auth" title="Permalink to this headline"></a></h1>
<p>Django-social-auth application, allows OpenId or OAuth user
registration/authentication just adding a few configurations.</p>
<div class="section" id="module-social_auth.models">
<span id="models"></span><h2>Models<a class="headerlink" href="#module-social_auth.models" title="Permalink to this headline"></a></h2>
<p>Social auth models</p>
<dl class="class">
<dt id="social_auth.models.Association">
<em class="property">class </em><tt class="descclassname">social_auth.models.</tt><tt class="descname">Association</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/models.html#Association"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.models.Association" title="Permalink to this definition"></a></dt>
<dd><p>OpenId account association</p>
</dd></dl>

<dl class="class">
<dt id="social_auth.models.Nonce">
<em class="property">class </em><tt class="descclassname">social_auth.models.</tt><tt class="descname">Nonce</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/models.html#Nonce"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.models.Nonce" title="Permalink to this definition"></a></dt>
<dd><p>One use numbers</p>
</dd></dl>

<dl class="class">
<dt id="social_auth.models.UserSocialAuth">
<em class="property">class </em><tt class="descclassname">social_auth.models.</tt><tt class="descname">UserSocialAuth</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/models.html#UserSocialAuth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.models.UserSocialAuth" title="Permalink to this definition"></a></dt>
<dd><p>Social Auth association model</p>
<dl class="method">
<dt id="social_auth.models.UserSocialAuth.expiration_delta">
<tt class="descname">expiration_delta</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/social_auth/models.html#UserSocialAuth.expiration_delta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.models.UserSocialAuth.expiration_delta" title="Permalink to this definition"></a></dt>
<dd><p>Return saved session expiration seconds if any. Is retuned in
the form of a timedelta data type. None is returned if there&#8217;s no
value stored or it&#8217;s malformed.</p>
</dd></dl>

</dd></dl>

<div class="section" id="module-social_auth.fields">
<span id="fields"></span><h3>Fields<a class="headerlink" href="#module-social_auth.fields" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="social_auth.fields.JSONField">
<em class="property">class </em><tt class="descclassname">social_auth.fields.</tt><tt class="descname">JSONField</tt><big>(</big><em>verbose_name=None</em>, <em>name=None</em>, <em>primary_key=False</em>, <em>max_length=None</em>, <em>unique=False</em>, <em>blank=False</em>, <em>null=False</em>, <em>db_index=False</em>, <em>rel=None</em>, <em>default=&lt;class django.db.models.fields.NOT_PROVIDED at 0x4d43410&gt;</em>, <em>editable=True</em>, <em>serialize=True</em>, <em>unique_for_date=None</em>, <em>unique_for_month=None</em>, <em>unique_for_year=None</em>, <em>choices=None</em>, <em>help_text=''</em>, <em>db_column=None</em>, <em>db_tablespace=None</em>, <em>auto_created=False</em>, <em>validators=</em><span class="optional">[</span><span class="optional">]</span>, <em>error_messages=None</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField" title="Permalink to this definition"></a></dt>
<dd><p>Simple JSON field that stores python structures as JSON strings
on database.</p>
<dl class="method">
<dt id="social_auth.fields.JSONField.get_prep_value">
<tt class="descname">get_prep_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField.get_prep_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField.get_prep_value" title="Permalink to this definition"></a></dt>
<dd><p>Convert value to JSON string before save</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.fields.JSONField.to_python">
<tt class="descname">to_python</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField.to_python"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField.to_python" title="Permalink to this definition"></a></dt>
<dd><p>Convert the input JSON value into python structures, raises
django.core.exceptions.ValidationError if the data can&#8217;t be converted.</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.fields.JSONField.validate">
<tt class="descname">validate</tt><big>(</big><em>value</em>, <em>model_instance</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField.validate" title="Permalink to this definition"></a></dt>
<dd><p>Check value is a valid JSON string, raise ValidationError on
error.</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.fields.JSONField.value_from_object">
<tt class="descname">value_from_object</tt><big>(</big><em>obj</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField.value_from_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField.value_from_object" title="Permalink to this definition"></a></dt>
<dd><p>Return value dumped to string.</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.fields.JSONField.value_to_string">
<tt class="descname">value_to_string</tt><big>(</big><em>obj</em><big>)</big><a class="reference internal" href="_modules/social_auth/fields.html#JSONField.value_to_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.fields.JSONField.value_to_string" title="Permalink to this definition"></a></dt>
<dd><p>Return value from object converted to string properly</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-social_auth.store">
<span id="store"></span><h3>Store<a class="headerlink" href="#module-social_auth.store" title="Permalink to this headline"></a></h3>
<p>OpenId storage that saves to django models</p>
<dl class="class">
<dt id="social_auth.store.DjangoOpenIDStore">
<em class="property">class </em><tt class="descclassname">social_auth.store.</tt><tt class="descname">DjangoOpenIDStore</tt><a class="reference internal" href="_modules/social_auth/store.html#DjangoOpenIDStore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.store.DjangoOpenIDStore" title="Permalink to this definition"></a></dt>
<dd><p>Storage class</p>
<dl class="method">
<dt id="social_auth.store.DjangoOpenIDStore.getAssociation">
<tt class="descname">getAssociation</tt><big>(</big><em>server_url</em>, <em>handle=None</em><big>)</big><a class="reference internal" href="_modules/social_auth/store.html#DjangoOpenIDStore.getAssociation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.store.DjangoOpenIDStore.getAssociation" title="Permalink to this definition"></a></dt>
<dd><p>Return stored assocition</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.store.DjangoOpenIDStore.storeAssociation">
<tt class="descname">storeAssociation</tt><big>(</big><em>server_url</em>, <em>association</em><big>)</big><a class="reference internal" href="_modules/social_auth/store.html#DjangoOpenIDStore.storeAssociation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.store.DjangoOpenIDStore.storeAssociation" title="Permalink to this definition"></a></dt>
<dd><p>Store new assocition if doesn&#8217;t exist</p>
</dd></dl>

<dl class="method">
<dt id="social_auth.store.DjangoOpenIDStore.useNonce">
<tt class="descname">useNonce</tt><big>(</big><em>server_url</em>, <em>timestamp</em>, <em>salt</em><big>)</big><a class="reference internal" href="_modules/social_auth/store.html#DjangoOpenIDStore.useNonce"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.store.DjangoOpenIDStore.useNonce" title="Permalink to this definition"></a></dt>
<dd><p>Generate one use number and return <em>if</em> it was created</p>
</dd></dl>

</dd></dl>

</div>
</div>
<div class="section" id="module-social_auth.admin">
<span id="admin"></span><h2>admin<a class="headerlink" href="#module-social_auth.admin" title="Permalink to this headline"></a></h2>
<p>Admin settings</p>
<dl class="class">
<dt id="social_auth.admin.AssociationOption">
<em class="property">class </em><tt class="descclassname">social_auth.admin.</tt><tt class="descname">AssociationOption</tt><big>(</big><em>model</em>, <em>admin_site</em><big>)</big><a class="reference internal" href="_modules/social_auth/admin.html#AssociationOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.admin.AssociationOption" title="Permalink to this definition"></a></dt>
<dd><p>Association options</p>
</dd></dl>

<dl class="class">
<dt id="social_auth.admin.NonceOption">
<em class="property">class </em><tt class="descclassname">social_auth.admin.</tt><tt class="descname">NonceOption</tt><big>(</big><em>model</em>, <em>admin_site</em><big>)</big><a class="reference internal" href="_modules/social_auth/admin.html#NonceOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.admin.NonceOption" title="Permalink to this definition"></a></dt>
<dd><p>Nonce options</p>
</dd></dl>

<dl class="class">
<dt id="social_auth.admin.UserSocialAuthOption">
<em class="property">class </em><tt class="descclassname">social_auth.admin.</tt><tt class="descname">UserSocialAuthOption</tt><big>(</big><em>model</em>, <em>admin_site</em><big>)</big><a class="reference internal" href="_modules/social_auth/admin.html#UserSocialAuthOption"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.admin.UserSocialAuthOption" title="Permalink to this definition"></a></dt>
<dd><p>Social Auth user options</p>
</dd></dl>

</div>
<div class="section" id="module-social_auth.context_processors">
<span id="context-processors"></span><h2>context processors<a class="headerlink" href="#module-social_auth.context_processors" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="social_auth.context_processors.backends_data">
<tt class="descclassname">social_auth.context_processors.</tt><tt class="descname">backends_data</tt><big>(</big><em>user</em><big>)</big><a class="reference internal" href="_modules/social_auth/context_processors.html#backends_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.context_processors.backends_data" title="Permalink to this definition"></a></dt>
<dd><p>Return backends data for given user.</p>
<dl class="docutils">
<dt>Will return a dict with values:</dt>
<dd><dl class="first docutils">
<dt>associated: UserSocialAuth model instances for currently</dt>
<dd>associated accounts</dd>
</dl>
<p class="last">not_associated: Not associated (yet) backend names.
backends: All backend names.</p>
</dd>
</dl>
<p>If user is not authenticated, then first list is empty, and there&#8217;s no
difference between the second and third lists.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.context_processors.social_auth_backends">
<tt class="descclassname">social_auth.context_processors.</tt><tt class="descname">social_auth_backends</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/social_auth/context_processors.html#social_auth_backends"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.context_processors.social_auth_backends" title="Permalink to this definition"></a></dt>
<dd><p>Load Social Auth current user data to context.
Will add a output from backends_data to context under social_auth key.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.context_processors.social_auth_by_name_backends">
<tt class="descclassname">social_auth.context_processors.</tt><tt class="descname">social_auth_by_name_backends</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/social_auth/context_processors.html#social_auth_by_name_backends"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.context_processors.social_auth_by_name_backends" title="Permalink to this definition"></a></dt>
<dd><p>Load Social Auth current user data to context.
Will add a social_auth object whose attribute names are the names of each
provider, e.g. social_auth.facebook would be the facebook association or 
None, depending on the logged in user&#8217;s current associations. Providers
with a hyphen have the hyphen replaced with an underscore, e.g. 
google-oauth2 becomes google_oauth2 when referenced in templates.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.context_processors.social_auth_by_type_backends">
<tt class="descclassname">social_auth.context_processors.</tt><tt class="descname">social_auth_by_type_backends</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/social_auth/context_processors.html#social_auth_by_type_backends"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.context_processors.social_auth_by_type_backends" title="Permalink to this definition"></a></dt>
<dd><p>Load Social Auth current user data to context.
Will add a output from backends_data to context under social_auth key where
each entry will be grouped by backend type (openid, oauth, oauth2).</p>
</dd></dl>

</div>
<div class="section" id="module-social_auth.signals">
<span id="signals"></span><h2>Signals<a class="headerlink" href="#module-social_auth.signals" title="Permalink to this headline"></a></h2>
<p>Signals</p>
</div>
<div class="section" id="module-social_auth.urls">
<span id="urls"></span><h2>Urls<a class="headerlink" href="#module-social_auth.urls" title="Permalink to this headline"></a></h2>
<p>URLs module</p>
</div>
<div class="section" id="module-social_auth.utils">
<span id="utils"></span><h2>Utils<a class="headerlink" href="#module-social_auth.utils" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="social_auth.utils.group_backend_by_type">
<tt class="descclassname">social_auth.utils.</tt><tt class="descname">group_backend_by_type</tt><big>(</big><em>items</em>, <em>key=&lt;function &lt;lambda&gt; at 0x5266320&gt;</em><big>)</big><a class="reference internal" href="_modules/social_auth/utils.html#group_backend_by_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.utils.group_backend_by_type" title="Permalink to this definition"></a></dt>
<dd><p>Group items by backend type.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.utils.sanitize_log_data">
<tt class="descclassname">social_auth.utils.</tt><tt class="descname">sanitize_log_data</tt><big>(</big><em>secret</em>, <em>data=None</em>, <em>leave_characters=4</em><big>)</big><a class="reference internal" href="_modules/social_auth/utils.html#sanitize_log_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.utils.sanitize_log_data" title="Permalink to this definition"></a></dt>
<dd><p>Clean private/secret data from log statements and other data.</p>
<p>Assumes data and secret are strings. Replaces all but the first
<cite>leave_characters</cite> of <cite>secret</cite>, as found in <cite>data</cite>, with &#8216;*&#8217;.</p>
<p>If no data is given, all but the first <cite>leave_characters</cite> of secret
are simply replaced and returned.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.utils.sanitize_redirect">
<tt class="descclassname">social_auth.utils.</tt><tt class="descname">sanitize_redirect</tt><big>(</big><em>host</em>, <em>redirect_to</em><big>)</big><a class="reference internal" href="_modules/social_auth/utils.html#sanitize_redirect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.utils.sanitize_redirect" title="Permalink to this definition"></a></dt>
<dd><p>Given the hostname and an untrusted URL to redirect to,
this method tests it to make sure it isn&#8217;t garbage/harmful
and returns it, else returns None.</p>
<p>See <a class="reference external" href="http://code.djangoproject.com/browser/django/trunk/django/contrib/auth/views.py#L36">http://code.djangoproject.com/browser/django/trunk/django/contrib/auth/views.py#L36</a></p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="p">{})</span>
<span class="go">None</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="s">&#39;http://notmyapp.com/path/&#39;</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="s">&#39;http://myapp.com/path/&#39;</span><span class="p">)</span>
<span class="go">http://myapp.com/path/</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">sanitize_redirect</span><span class="p">(</span><span class="s">&#39;myapp.com&#39;</span><span class="p">,</span> <span class="s">&#39;/path/&#39;</span><span class="p">)</span>
<span class="go">/path/</span>
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="social_auth.utils.setting">
<tt class="descclassname">social_auth.utils.</tt><tt class="descname">setting</tt><big>(</big><em>name</em>, <em>default=None</em><big>)</big><a class="reference internal" href="_modules/social_auth/utils.html#setting"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.utils.setting" title="Permalink to this definition"></a></dt>
<dd><p>Return setting value for given name or default value.</p>
</dd></dl>

</div>
<div class="section" id="module-social_auth.views">
<span id="views"></span><h2>views<a class="headerlink" href="#module-social_auth.views" title="Permalink to this headline"></a></h2>
<p>Views</p>
<dl class="docutils">
<dt>Notes:</dt>
<dd><ul class="first last simple">
<li>Some views are marked to avoid csrf tocken check becuase they relay
on third party providers that (if using POST) won&#8217;t be sending crfs
token back.</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt id="social_auth.views.associate">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">associate</tt><big>(</big><em>request</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#associate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.associate" title="Permalink to this definition"></a></dt>
<dd><p>Authentication starting process</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.associate_complete">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">associate_complete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#associate_complete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.associate_complete" title="Permalink to this definition"></a></dt>
<dd><p>Authentication complete process</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.auth">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">auth</tt><big>(</big><em>request</em>, <em>backend</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#auth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.auth" title="Permalink to this definition"></a></dt>
<dd><p>Start authentication process</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.auth_complete">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">auth_complete</tt><big>(</big><em>request</em>, <em>backend</em>, <em>user=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#auth_complete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.auth_complete" title="Permalink to this definition"></a></dt>
<dd><p>Complete auth process. Return authenticated user or None.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.auth_process">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">auth_process</tt><big>(</big><em>request</em>, <em>backend</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#auth_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.auth_process" title="Permalink to this definition"></a></dt>
<dd><p>Authenticate using social backend</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.complete">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">complete</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#complete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.complete" title="Permalink to this definition"></a></dt>
<dd><p>Authentication complete view, override this view if transaction
management doesn&#8217;t suit your needs.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.complete_process">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">complete_process</tt><big>(</big><em>request</em>, <em>backend</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#complete_process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.complete_process" title="Permalink to this definition"></a></dt>
<dd><p>Authentication complete process</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.disconnect">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">disconnect</tt><big>(</big><em>request</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.disconnect" title="Permalink to this definition"></a></dt>
<dd><p>Disconnects given backend from current logged in user.</p>
</dd></dl>

<dl class="function">
<dt id="social_auth.views.dsa_view">
<tt class="descclassname">social_auth.views.</tt><tt class="descname">dsa_view</tt><big>(</big><em>redirect_name=None</em><big>)</big><a class="reference internal" href="_modules/social_auth/views.html#dsa_view"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#social_auth.views.dsa_view" title="Permalink to this definition"></a></dt>
<dd><p>Decorate djangos-social-auth views. Will check and retrieve backend
or return HttpResponseServerError if backend is not found.</p>
<p>redirect_name parameter is used to build redirect URL used by backend.</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The User Social Auth Module</a><ul>
<li><a class="reference internal" href="#module-social_auth.models">Models</a><ul>
<li><a class="reference internal" href="#module-social_auth.fields">Fields</a></li>
<li><a class="reference internal" href="#module-social_auth.store">Store</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-social_auth.admin">admin</a></li>
<li><a class="reference internal" href="#module-social_auth.context_processors">context processors</a></li>
<li><a class="reference internal" href="#module-social_auth.signals">Signals</a></li>
<li><a class="reference internal" href="#module-social_auth.urls">Urls</a></li>
<li><a class="reference internal" href="#module-social_auth.utils">Utils</a></li>
<li><a class="reference internal" href="#module-social_auth.views">views</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="externalapps.html"
                        title="previous chapter">External apps used in this project</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="djcelery.html"
                        title="next chapter">The Django Celery Module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/social_auth.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="djcelery.html" title="The Django Celery Module"
             >next</a> |</li>
        <li class="right" >
          <a href="externalapps.html" title="External apps used in this project"
             >previous</a> |</li>
        <li><a href="index.html">EggDiscover 0.1 documentation</a> &raquo;</li>
          <li><a href="externalapps.html" >External apps used in this project</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Yohann Gabory.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
    </div>
  </body>
</html>