Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d67010d98769c7f0b7792ce26b8ca7527dd3561c / . / docs / epy / oauth2client.client.AssertionCredentials-class.html
blob: 3fd85f16d36b7e8e6ea715597489531c9f89d28b [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">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]59<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html" title="AssertionCredentials" alt="" coords="5,5,147,32"/>
60<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="171,5,256,32"/>
61<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="280,5,411,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]62</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]63 <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]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68Abstract Credentials object used for OAuth 2.0 assertion grants.
69
70This credential does not require a flow to instantiate because it
71represents a two legged flow, and therefore has all of the required
72information to generate and refresh its own access tokens. It must
73be subclassed to generate the appropriate assertion string.
74
75AssertionCredentials objects may be safely pickled and unpickled.
76
77</pre>
78
79<!-- ==================== INSTANCE METHODS ==================== -->
80<a name="section-InstanceMethods"></a>
81<table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83<tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
86 <tr valign="top">
87 <td align="left"><span class="table-header">Instance Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-InstanceMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
92 </tr>
93 </table>
94 </td>
95</tr>
96<tr>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]102 <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
103 <span class="summary-sig-arg">assertion_type</span>,
104 <span class="summary-sig-arg">user_agent</span>=<span class="summary-sig-default">None</span>,
105 <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default">'https://accounts.google.com/o/oauth2/token'</span>,
106 <span class="summary-sig-arg">**unused_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 Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]109 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">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>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]157 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]158 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
159 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
160 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
161 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
162 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
163 </p>
164 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
165 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
166 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
167 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,
168 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
169 </p></div>
170 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
171 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
172 </p></div>
173 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
174 <code>__delattr__</code>,
175 <code>__format__</code>,
176 <code>__getattribute__</code>,
177 <code>__hash__</code>,
178 <code>__new__</code>,
179 <code>__reduce__</code>,
180 <code>__reduce_ex__</code>,
181 <code>__repr__</code>,
182 <code>__setattr__</code>,
183 <code>__sizeof__</code>,
184 <code>__str__</code>,
185 <code>__subclasshook__</code>
186 </p>
187 </td>
188 </tr>
189</table>
190<!-- ==================== CLASS METHODS ==================== -->
191<a name="section-ClassMethods"></a>
192<table class="summary" border="1" cellpadding="3"
193 cellspacing="0" width="100%" bgcolor="white">
194<tr bgcolor="#70b0f0" class="table-header">
195 <td colspan="2" class="table-header">
196 <table border="0" cellpadding="0" cellspacing="0" width="100%">
197 <tr valign="top">
198 <td align="left"><span class="table-header">Class Methods</span></td>
199 <td align="right" valign="top"
200 ><span class="options">[<a href="#section-ClassMethods"
201 class="privatelink" onclick="toggle_private();"
202 >hide private</a>]</span></td>
203 </tr>
204 </table>
205 </td>
206</tr>
207 <tr>
208 <td colspan="2" class="summary">
209 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
210 <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>
211 </p>
212 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
213 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
214 </p>
215 </td>
216 </tr>
217</table>
218<!-- ==================== CLASS VARIABLES ==================== -->
219<a name="section-ClassVariables"></a>
220<table class="summary" border="1" cellpadding="3"
221 cellspacing="0" width="100%" bgcolor="white">
222<tr bgcolor="#70b0f0" class="table-header">
223 <td colspan="2" class="table-header">
224 <table border="0" cellpadding="0" cellspacing="0" width="100%">
225 <tr valign="top">
226 <td align="left"><span class="table-header">Class Variables</span></td>
227 <td align="right" valign="top"
228 ><span class="options">[<a href="#section-ClassVariables"
229 class="privatelink" onclick="toggle_private();"
230 >hide private</a>]</span></td>
231 </tr>
232 </table>
233 </td>
234</tr>
235 <tr>
236 <td colspan="2" class="summary">
237 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
238 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
239 </p>
240 </td>
241 </tr>
242</table>
243<!-- ==================== PROPERTIES ==================== -->
244<a name="section-Properties"></a>
245<table class="summary" border="1" cellpadding="3"
246 cellspacing="0" width="100%" bgcolor="white">
247<tr bgcolor="#70b0f0" class="table-header">
248 <td colspan="2" class="table-header">
249 <table border="0" cellpadding="0" cellspacing="0" width="100%">
250 <tr valign="top">
251 <td align="left"><span class="table-header">Properties</span></td>
252 <td align="right" valign="top"
253 ><span class="options">[<a href="#section-Properties"
254 class="privatelink" onclick="toggle_private();"
255 >hide private</a>]</span></td>
256 </tr>
257 </table>
258 </td>
259</tr>
260 <tr>
261 <td colspan="2" class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]262 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
263 <code>__class__</code>
264 </p>
265 </td>
266 </tr>
267</table>
268<!-- ==================== METHOD DETAILS ==================== -->
269<a name="section-MethodDetails"></a>
270<table class="details" border="1" cellpadding="3"
271 cellspacing="0" width="100%" bgcolor="white">
272<tr bgcolor="#70b0f0" class="table-header">
273 <td colspan="2" class="table-header">
274 <table border="0" cellpadding="0" cellspacing="0" width="100%">
275 <tr valign="top">
276 <td align="left"><span class="table-header">Method Details</span></td>
277 <td align="right" valign="top"
278 ><span class="options">[<a href="#section-MethodDetails"
279 class="privatelink" onclick="toggle_private();"
280 >hide private</a>]</span></td>
281 </tr>
282 </table>
283 </td>
284</tr>
285</table>
286<a name="__init__"></a>
287<div>
288<table class="details" border="1" cellpadding="3"
289 cellspacing="0" width="100%" bgcolor="white">
290<tr><td>
291 <table width="100%" cellpadding="0" cellspacing="0" border="0">
292 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]293 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
294 <span class="sig-arg">assertion_type</span>,
295 <span class="sig-arg">user_agent</span>=<span class="sig-default">None</span>,
296 <span class="sig-arg">token_uri</span>=<span class="sig-default">'https://accounts.google.com/o/oauth2/token'</span>,
297 <span class="sig-arg">**unused_kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]298 <br /><em class="fname">(Constructor)</em>
299 </h3>
300 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]301 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]302 </td>
303 </tr></table>
304
305 <pre class="literalblock">
306Constructor for AssertionFlowCredentials.
307
308Args:
309 assertion_type: string, assertion type that will be declared to the auth
310 server
311 user_agent: string, The HTTP User-Agent to provide for this application.
312 token_uri: string, URI for token endpoint. For convenience
313 defaults to Google's endpoints but any OAuth 2.0 provider can be used.
314
315</pre>
316 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]317 <dt>Decorators:</dt>
318 <dd><ul class="nomargin-top">
319 <li><code>@util.positional(2)</code></li>
320 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]321 <dt>Overrides:
322 object.__init__
323 </dt>
324 </dl>
325</td></tr></table>
326</div>
327<a name="_generate_refresh_request_body"></a>
328<div class="private">
329<table class="details" border="1" cellpadding="3"
330 cellspacing="0" width="100%" bgcolor="white">
331<tr><td>
332 <table width="100%" cellpadding="0" cellspacing="0" border="0">
333 <tr valign="top"><td>
334 <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span>
335 </h3>
336 </td><td align="right" valign="top"
337 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>&nbsp;
338 </td>
339 </tr></table>
340
341 <pre class="literalblock">
342Generate the body that will be used in the refresh request.
343
344</pre>
345 <dl class="fields">
346 <dt>Overrides:
347 <a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a>
348 <dd><em class="note">(inherited documentation)</em></dd>
349 </dt>
350 </dl>
351</td></tr></table>
352</div>
353<br />
354<!-- ==================== NAVIGATION BAR ==================== -->
355<table class="navbar" border="0" width="100%" cellpadding="0"
356 bgcolor="#a0c0ff" cellspacing="0">
357 <tr valign="middle">
358
359 <!-- Tree link -->
360 <th>&nbsp;&nbsp;&nbsp;<a
361 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
362
363 <!-- Index link -->
364 <th>&nbsp;&nbsp;&nbsp;<a
365 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
366
367 <!-- Help link -->
368 <th>&nbsp;&nbsp;&nbsp;<a
369 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
370
371 <th class="navbar" width="100%"></th>
372 </tr>
373</table>
374<table border="0" cellpadding="0" cellspacing="0" width="100%%">
375 <tr>
376 <td align="left" class="footer">
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]377 Generated by Epydoc 3.0.1 on Mon Nov 5 08:53:55 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]378 </td>
379 <td align="right" class="footer">
380 <a target="mainFrame" href="http://epydoc.sourceforge.net"
381 >http://epydoc.sourceforge.net</a>
382 </td>
383 </tr>
384</table>
385
386<script type="text/javascript">
387 <!--
388 // Private objects are initially displayed (because if
389 // javascript is turned off then we want them to be
390 // visible); but by default, we want to hide them. So hide
391 // them unless we have a cookie that says to show them.
392 checkCookie();
393 // -->
394</script>
395</body>
396</html>