Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d37e76fad280dda7565e08efe6a0426e081fd542 / . / docs / epy / oauth2client.client.AssertionCredentials-class.html
blob: 141d0be7de28c08f9443bb561082edcda7b9b6b0 [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"/>
60<area shape="rect" href="oauth2client.client.AssertionCredentials-class.html" title="AssertionCredentials" alt="" coords="167,117,308,144"/>
61<area shape="rect" href="oauth2client.client.SignedJwtAssertionCredentials-class.html" title="SignedJwtAssertionCredentials" alt="" coords="256,173,456,200"/>
62<area shape="rect" href="oauth2client.client.Credentials-class.html" title="Credentials" alt="" coords="195,5,280,32"/>
63<area shape="rect" href="oauth2client.client.OAuth2Credentials-class.html" title="OAuth2Credentials" alt="" coords="172,61,303,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]65 <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]66</center>
67</center>
68<hr />
69<pre class="literalblock">
70Abstract Credentials object used for OAuth 2.0 assertion grants.
71
72This credential does not require a flow to instantiate because it
73represents a two legged flow, and therefore has all of the required
74information to generate and refresh its own access tokens. It must
75be subclassed to generate the appropriate assertion string.
76
77AssertionCredentials objects may be safely pickled and unpickled.
78
79</pre>
80
81<!-- ==================== INSTANCE METHODS ==================== -->
82<a name="section-InstanceMethods"></a>
83<table class="summary" border="1" cellpadding="3"
84 cellspacing="0" width="100%" bgcolor="white">
85<tr bgcolor="#70b0f0" class="table-header">
86 <td colspan="2" class="table-header">
87 <table border="0" cellpadding="0" cellspacing="0" width="100%">
88 <tr valign="top">
89 <td align="left"><span class="table-header">Instance Methods</span></td>
90 <td align="right" valign="top"
91 ><span class="options">[<a href="#section-InstanceMethods"
92 class="privatelink" onclick="toggle_private();"
93 >hide private</a>]</span></td>
94 </tr>
95 </table>
96 </td>
97</tr>
98<tr>
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type">&nbsp;</span>
101 </td><td class="summary">
102 <table width="100%" cellpadding="0" cellspacing="0" border="0">
103 <tr>
104 <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>,
105 <span class="summary-sig-arg">assertion_type</span>,
106 <span class="summary-sig-arg">user_agent</span>,
107 <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">https://accounts.google.com/o/oauth2/token</code><code class="variable-quote">'</code></span>,
108 <span class="summary-sig-arg">**unused_kwargs</span>)</span><br />
109 Constructor for AssertionFlowCredentials.</td>
110 <td align="right" valign="top">
111 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source&nbsp;code</a></span>
112
113 </td>
114 </tr>
115 </table>
116
117 </td>
118 </tr>
119<tr class="private">
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <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 />
126 Generate the body that will be used in the refresh request.</td>
127 <td align="right" valign="top">
128 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136<tr class="private">
137 <td width="15%" align="right" valign="top" class="summary">
138 <span class="summary-type">&nbsp;</span>
139 </td><td class="summary">
140 <table width="100%" cellpadding="0" cellspacing="0" border="0">
141 <tr>
142 <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 />
143 Generate the assertion string that will be used in the access token
144request.</td>
145 <td align="right" valign="top">
146 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source&nbsp;code</a></span>
147
148 </td>
149 </tr>
150 </table>
151
152 </td>
153 </tr>
154 <tr>
155 <td colspan="2" class="summary">
156 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
157 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
158 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
159 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
160 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
161 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
162 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
163 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
164 </p>
165 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
166 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
167 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
168 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,
169 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
170 </p></div>
171 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
172 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
173 </p></div>
174 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
175 <code>__delattr__</code>,
176 <code>__format__</code>,
177 <code>__getattribute__</code>,
178 <code>__hash__</code>,
179 <code>__new__</code>,
180 <code>__reduce__</code>,
181 <code>__reduce_ex__</code>,
182 <code>__repr__</code>,
183 <code>__setattr__</code>,
184 <code>__sizeof__</code>,
185 <code>__str__</code>,
186 <code>__subclasshook__</code>
187 </p>
188 </td>
189 </tr>
190</table>
191<!-- ==================== CLASS METHODS ==================== -->
192<a name="section-ClassMethods"></a>
193<table class="summary" border="1" cellpadding="3"
194 cellspacing="0" width="100%" bgcolor="white">
195<tr bgcolor="#70b0f0" class="table-header">
196 <td colspan="2" class="table-header">
197 <table border="0" cellpadding="0" cellspacing="0" width="100%">
198 <tr valign="top">
199 <td align="left"><span class="table-header">Class Methods</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-ClassMethods"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
204 </tr>
205 </table>
206 </td>
207</tr>
208 <tr>
209 <td colspan="2" class="summary">
210 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
211 <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>
212 </p>
213 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
214 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
215 </p>
216 </td>
217 </tr>
218</table>
219<!-- ==================== CLASS VARIABLES ==================== -->
220<a name="section-ClassVariables"></a>
221<table class="summary" border="1" cellpadding="3"
222 cellspacing="0" width="100%" bgcolor="white">
223<tr bgcolor="#70b0f0" class="table-header">
224 <td colspan="2" class="table-header">
225 <table border="0" cellpadding="0" cellspacing="0" width="100%">
226 <tr valign="top">
227 <td align="left"><span class="table-header">Class Variables</span></td>
228 <td align="right" valign="top"
229 ><span class="options">[<a href="#section-ClassVariables"
230 class="privatelink" onclick="toggle_private();"
231 >hide private</a>]</span></td>
232 </tr>
233 </table>
234 </td>
235</tr>
236 <tr>
237 <td colspan="2" class="summary">
238 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
239 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
240 </p>
241 </td>
242 </tr>
243</table>
244<!-- ==================== PROPERTIES ==================== -->
245<a name="section-Properties"></a>
246<table class="summary" border="1" cellpadding="3"
247 cellspacing="0" width="100%" bgcolor="white">
248<tr bgcolor="#70b0f0" class="table-header">
249 <td colspan="2" class="table-header">
250 <table border="0" cellpadding="0" cellspacing="0" width="100%">
251 <tr valign="top">
252 <td align="left"><span class="table-header">Properties</span></td>
253 <td align="right" valign="top"
254 ><span class="options">[<a href="#section-Properties"
255 class="privatelink" onclick="toggle_private();"
256 >hide private</a>]</span></td>
257 </tr>
258 </table>
259 </td>
260</tr>
261 <tr>
262 <td colspan="2" class="summary">
263 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
264 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>
265 </p>
266 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
267 <code>__class__</code>
268 </p>
269 </td>
270 </tr>
271</table>
272<!-- ==================== METHOD DETAILS ==================== -->
273<a name="section-MethodDetails"></a>
274<table class="details" border="1" cellpadding="3"
275 cellspacing="0" width="100%" bgcolor="white">
276<tr bgcolor="#70b0f0" class="table-header">
277 <td colspan="2" class="table-header">
278 <table border="0" cellpadding="0" cellspacing="0" width="100%">
279 <tr valign="top">
280 <td align="left"><span class="table-header">Method Details</span></td>
281 <td align="right" valign="top"
282 ><span class="options">[<a href="#section-MethodDetails"
283 class="privatelink" onclick="toggle_private();"
284 >hide private</a>]</span></td>
285 </tr>
286 </table>
287 </td>
288</tr>
289</table>
290<a name="__init__"></a>
291<div>
292<table class="details" border="1" cellpadding="3"
293 cellspacing="0" width="100%" bgcolor="white">
294<tr><td>
295 <table width="100%" cellpadding="0" cellspacing="0" border="0">
296 <tr valign="top"><td>
297 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
298 <span class="sig-arg">assertion_type</span>,
299 <span class="sig-arg">user_agent</span>,
300 <span class="sig-arg">token_uri</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">https://accounts.google.com/o/oauth2/token</code><code class="variable-quote">'</code></span>,
301 <span class="sig-arg">**unused_kwargs</span>)</span>
302 <br /><em class="fname">(Constructor)</em>
303 </h3>
304 </td><td align="right" valign="top"
305 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source&nbsp;code</a></span>&nbsp;
306 </td>
307 </tr></table>
308
309 <pre class="literalblock">
310Constructor for AssertionFlowCredentials.
311
312Args:
313 assertion_type: string, assertion type that will be declared to the auth
314 server
315 user_agent: string, The HTTP User-Agent to provide for this application.
316 token_uri: string, URI for token endpoint. For convenience
317 defaults to Google's endpoints but any OAuth 2.0 provider can be used.
318
319</pre>
320 <dl class="fields">
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 Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]377 Generated by Epydoc 3.0.1 on Fri Jun 15 13:13:24 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>