Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1b425aab261532e775551125c8f7aca3562de144 / . / docs / epy / oauth2client.client.AssertionCredentials-class.html
blob: e1b743b3993a2aeee7cbf1d69056a89c82da6bc6 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.client.AssertionCredentials</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.client-module.html">Module&nbsp;client</a> ::
39 Class&nbsp;AssertionCredentials
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.client.AssertionCredentials-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class AssertionCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_assertionc" name="class_hierarchy_for_assertionc">
59<area shape="rect" href="oauth2client.appengine.AppAssertionCredentials-class.html" title="appengine.AppAssertionCredentials" alt="" coords="5,173,232,200"/>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]60<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html" title="AssertionCredentials" alt="" coords="285,117,427,144"/>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]61<area shape="rect" href="oauth2client.client.SignedJwtAssertionCredentials-class.html" title="SignedJwtAssertionCredentials" alt="" coords="256,173,456,200"/>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]62<area shape="rect" href="oauth2client.gce.AppAssertionCredentials-class.html" title="gce.AppAssertionCredentials" alt="" coords="480,173,669,200"/>
63<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="313,5,399,32"/>
64<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="291,61,421,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]65</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]66 <img src="class_hierarchy_for_assertionc.gif" alt='' usemap="#class_hierarchy_for_assertionc" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]67</center>
68</center>
69<hr />
70<pre class="literalblock">
71Abstract Credentials object used for OAuth 2.0 assertion grants.
72
73This credential does not require a flow to instantiate because it
74represents a two legged flow, and therefore has all of the required
75information to generate and refresh its own access tokens. It must
76be subclassed to generate the appropriate assertion string.
77
78AssertionCredentials objects may be safely pickled and unpickled.
79
80</pre>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]105 <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
106 <span class="summary-sig-arg">**kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]107 Constructor for AssertionFlowCredentials.</td>
108 <td align="right" valign="top">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]109 <span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117<tr class="private">
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
123 <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body" class="summary-sig-name" onclick="show_private();">_generate_refresh_request_body</a>(<span class="summary-sig-arg">self</span>)</span><br />
124 Generate the body that will be used in the refresh request.</td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>
127
128 </td>
129 </tr>
130 </table>
131
132 </td>
133 </tr>
134<tr class="private">
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td><span class="summary-sig"><a name="_generate_assertion"></a><span class="summary-sig-name">_generate_assertion</span>(<span class="summary-sig-arg">self</span>)</span><br />
141 Generate the assertion string that will be used in the access token
142request.</td>
143 <td align="right" valign="top">
144 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source&nbsp;code</a></span>
145
146 </td>
147 </tr>
148 </table>
149
150 </td>
151 </tr>
152 <tr>
153 <td colspan="2" class="summary">
154 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
155 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
156 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
157 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
158 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
159 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
160 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
161 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
162 </p>
163 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
164 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
165 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
166 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,
167 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
168 </p></div>
169 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
170 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
171 </p></div>
172 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
173 <code>__delattr__</code>,
174 <code>__format__</code>,
175 <code>__getattribute__</code>,
176 <code>__hash__</code>,
177 <code>__new__</code>,
178 <code>__reduce__</code>,
179 <code>__reduce_ex__</code>,
180 <code>__repr__</code>,
181 <code>__setattr__</code>,
182 <code>__sizeof__</code>,
183 <code>__str__</code>,
184 <code>__subclasshook__</code>
185 </p>
186 </td>
187 </tr>
188</table>
189<!-- ==================== CLASS METHODS ==================== -->
190<a name="section-ClassMethods"></a>
191<table class="summary" border="1" cellpadding="3"
192 cellspacing="0" width="100%" bgcolor="white">
193<tr bgcolor="#70b0f0" class="table-header">
194 <td colspan="2" class="table-header">
195 <table border="0" cellpadding="0" cellspacing="0" width="100%">
196 <tr valign="top">
197 <td align="left"><span class="table-header">Class Methods</span></td>
198 <td align="right" valign="top"
199 ><span class="options">[<a href="#section-ClassMethods"
200 class="privatelink" onclick="toggle_private();"
201 >hide private</a>]</span></td>
202 </tr>
203 </table>
204 </td>
205</tr>
206 <tr>
207 <td colspan="2" class="summary">
208 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
209 <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>
210 </p>
211 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
212 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
213 </p>
214 </td>
215 </tr>
216</table>
217<!-- ==================== CLASS VARIABLES ==================== -->
218<a name="section-ClassVariables"></a>
219<table class="summary" border="1" cellpadding="3"
220 cellspacing="0" width="100%" bgcolor="white">
221<tr bgcolor="#70b0f0" class="table-header">
222 <td colspan="2" class="table-header">
223 <table border="0" cellpadding="0" cellspacing="0" width="100%">
224 <tr valign="top">
225 <td align="left"><span class="table-header">Class Variables</span></td>
226 <td align="right" valign="top"
227 ><span class="options">[<a href="#section-ClassVariables"
228 class="privatelink" onclick="toggle_private();"
229 >hide private</a>]</span></td>
230 </tr>
231 </table>
232 </td>
233</tr>
234 <tr>
235 <td colspan="2" class="summary">
236 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
237 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
238 </p>
239 </td>
240 </tr>
241</table>
242<!-- ==================== PROPERTIES ==================== -->
243<a name="section-Properties"></a>
244<table class="summary" border="1" cellpadding="3"
245 cellspacing="0" width="100%" bgcolor="white">
246<tr bgcolor="#70b0f0" class="table-header">
247 <td colspan="2" class="table-header">
248 <table border="0" cellpadding="0" cellspacing="0" width="100%">
249 <tr valign="top">
250 <td align="left"><span class="table-header">Properties</span></td>
251 <td align="right" valign="top"
252 ><span class="options">[<a href="#section-Properties"
253 class="privatelink" onclick="toggle_private();"
254 >hide private</a>]</span></td>
255 </tr>
256 </table>
257 </td>
258</tr>
259 <tr>
260 <td colspan="2" class="summary">
261 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
262 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>
263 </p>
264 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
265 <code>__class__</code>
266 </p>
267 </td>
268 </tr>
269</table>
270<!-- ==================== METHOD DETAILS ==================== -->
271<a name="section-MethodDetails"></a>
272<table class="details" border="1" cellpadding="3"
273 cellspacing="0" width="100%" bgcolor="white">
274<tr bgcolor="#70b0f0" class="table-header">
275 <td colspan="2" class="table-header">
276 <table border="0" cellpadding="0" cellspacing="0" width="100%">
277 <tr valign="top">
278 <td align="left"><span class="table-header">Method Details</span></td>
279 <td align="right" valign="top"
280 ><span class="options">[<a href="#section-MethodDetails"
281 class="privatelink" onclick="toggle_private();"
282 >hide private</a>]</span></td>
283 </tr>
284 </table>
285 </td>
286</tr>
287</table>
288<a name="__init__"></a>
289<div>
290<table class="details" border="1" cellpadding="3"
291 cellspacing="0" width="100%" bgcolor="white">
292<tr><td>
293 <table width="100%" cellpadding="0" cellspacing="0" border="0">
294 <tr valign="top"><td>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]295 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
296 <span class="sig-arg">**kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]297 <br /><em class="fname">(Constructor)</em>
298 </h3>
299 </td><td align="right" valign="top"
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]300 ><span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]301 </td>
302 </tr></table>
303
304 <pre class="literalblock">
305Constructor for AssertionFlowCredentials.
306
307Args:
308 assertion_type: string, assertion type that will be declared to the auth
309 server
310 user_agent: string, The HTTP User-Agent to provide for this application.
311 token_uri: string, URI for token endpoint. For convenience
312 defaults to Google's endpoints but any OAuth 2.0 provider can be used.
313
314</pre>
315 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]316 <dt>Decorators:</dt>
317 <dd><ul class="nomargin-top">
318 <li><code>@util.positional(2)</code></li>
319 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]320 <dt>Overrides:
321 object.__init__
322 </dt>
323 </dl>
324</td></tr></table>
325</div>
326<a name="_generate_refresh_request_body"></a>
327<div class="private">
328<table class="details" border="1" cellpadding="3"
329 cellspacing="0" width="100%" bgcolor="white">
330<tr><td>
331 <table width="100%" cellpadding="0" cellspacing="0" border="0">
332 <tr valign="top"><td>
333 <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span>
334 </h3>
335 </td><td align="right" valign="top"
336 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>&nbsp;
337 </td>
338 </tr></table>
339
340 <pre class="literalblock">
341Generate the body that will be used in the refresh request.
342
343</pre>
344 <dl class="fields">
345 <dt>Overrides:
346 <a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a>
347 <dd><em class="note">(inherited documentation)</em></dd>
348 </dt>
349 </dl>
350</td></tr></table>
351</div>
352<br />
353<!-- ==================== NAVIGATION BAR ==================== -->
354<table class="navbar" border="0" width="100%" cellpadding="0"
355 bgcolor="#a0c0ff" cellspacing="0">
356 <tr valign="middle">
357
358 <!-- Tree link -->
359 <th>&nbsp;&nbsp;&nbsp;<a
360 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
361
362 <!-- Index link -->
363 <th>&nbsp;&nbsp;&nbsp;<a
364 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
365
366 <!-- Help link -->
367 <th>&nbsp;&nbsp;&nbsp;<a
368 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
369
370 <th class="navbar" width="100%"></th>
371 </tr>
372</table>
373<table border="0" cellpadding="0" cellspacing="0" width="100%%">
374 <tr>
375 <td align="left" class="footer">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]376 Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:05 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]377 </td>
378 <td align="right" class="footer">
379 <a target="mainFrame" href="http://epydoc.sourceforge.net"
380 >http://epydoc.sourceforge.net</a>
381 </td>
382 </tr>
383</table>
384
385<script type="text/javascript">
386 <!--
387 // Private objects are initially displayed (because if
388 // javascript is turned off then we want them to be
389 // visible); but by default, we want to hide them. So hide
390 // them unless we have a cookie that says to show them.
391 checkCookie();
392 // -->
393</script>
394</body>
395</html>