Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / oauth2client.client.AssertionCredentials-class.html
blob: 6f718ad02dcecb874f049b2bd5a7d29753554a92 [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 Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_oauth2cl_18" name="uml_class_diagram_for_oauth2cl_18">
59<area shape="rect" id="node143" href="oauth2client.client.AssertionCredentials-class.html#__init__" title="Constructor for AssertionFlowCredentials." alt="" coords="17,375,847,393"/>
60<area shape="rect" id="node1" href="oauth2client.client.AssertionCredentials-class.html" title="Abstract Credentials object used for OAuth 2.0 assertion grants." alt="" coords="5,342,859,399"/>
61<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#authorize" title="Authorize an httplib2.Http instance with these credentials." alt="" coords="348,129,515,148"/>
62<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#refresh" title="Forces a refresh of the access_token." alt="" coords="348,148,515,167"/>
63<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#revoke" title="Revokes a refresh_token and makes the credentials void." alt="" coords="348,167,515,185"/>
64<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#apply" title="Add the authorization to the headers." alt="" coords="348,185,515,204"/>
65<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="348,204,515,223"/>
66<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#from_json" title="Instantiate a Credentials object from a JSON description of it." alt="" coords="348,223,515,241"/>
67<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" title="True if the credential is expired or invalid." alt="" coords="348,241,515,260"/>
68<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#set_store" title="Set the Storage for the credential." alt="" coords="348,260,515,279"/>
69<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="348,279,515,297"/>
70<area shape="rect" id="node144" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="348,297,515,316"/>
71<area shape="rect" id="node2" href="oauth2client.client.OAuth2Credentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="336,97,525,322"/>
72<area shape="rect" id="node145" href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS" title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" alt="" coords="332,31,531,49"/>
73<area shape="rect" id="node145" href="oauth2client.client.Credentials-class.html#new_from_json" title="Utility class method to instantiate a Credentials subclass from a JSON representation produced by to_json()." alt="" coords="332,52,531,71"/>
74<area shape="rect" id="node3" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="320,6,541,77"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]75</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]76 <img src="uml_class_diagram_for_oauth2cl_18.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_18" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]77</center>
78</center>
79<hr />
80<pre class="literalblock">
81Abstract Credentials object used for OAuth 2.0 assertion grants.
82
83This credential does not require a flow to instantiate because it
84represents a two legged flow, and therefore has all of the required
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]85information to generate and refresh its own access tokens. It must
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]86be subclassed to generate the appropriate assertion string.
87
88AssertionCredentials objects may be safely pickled and unpickled.
89
90</pre>
91
92<!-- ==================== INSTANCE METHODS ==================== -->
93<a name="section-InstanceMethods"></a>
94<table class="summary" border="1" cellpadding="3"
95 cellspacing="0" width="100%" bgcolor="white">
96<tr bgcolor="#70b0f0" class="table-header">
97 <td colspan="2" class="table-header">
98 <table border="0" cellpadding="0" cellspacing="0" width="100%">
99 <tr valign="top">
100 <td align="left"><span class="table-header">Instance Methods</span></td>
101 <td align="right" valign="top"
102 ><span class="options">[<a href="#section-InstanceMethods"
103 class="privatelink" onclick="toggle_private();"
104 >hide private</a>]</span></td>
105 </tr>
106 </table>
107 </td>
108</tr>
109<tr>
110 <td width="15%" align="right" valign="top" class="summary">
111 <span class="summary-type">&nbsp;</span>
112 </td><td class="summary">
113 <table width="100%" cellpadding="0" cellspacing="0" border="0">
114 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]115 <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>,
116 <span class="summary-sig-arg">assertion_type</span>,
117 <span class="summary-sig-arg">user_agent</span>=<span class="summary-sig-default">None</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]118 <span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default">GOOGLE_TOKEN_URI</span>,
119 <span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">GOOGLE_REVOKE_URI</span>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]120 <span class="summary-sig-arg">**unused_kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]121 Constructor for AssertionFlowCredentials.</td>
122 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]123 <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]124
125 </td>
126 </tr>
127 </table>
128
129 </td>
130 </tr>
131<tr class="private">
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <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 />
138 Generate the body that will be used in the refresh request.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr class="private">
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <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 />
155 Generate the assertion string that will be used in the access token
156request.</td>
157 <td align="right" valign="top">
158 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source&nbsp;code</a></span>
159
160 </td>
161 </tr>
162 </table>
163
164 </td>
165 </tr>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]166<tr class="private">
167 <td width="15%" align="right" valign="top" class="summary">
168 <span class="summary-type">&nbsp;</span>
169 </td><td class="summary">
170 <table width="100%" cellpadding="0" cellspacing="0" border="0">
171 <tr>
172 <td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_revoke" class="summary-sig-name" onclick="show_private();">_revoke</a>(<span class="summary-sig-arg">self</span>,
173 <span class="summary-sig-arg">http_request</span>)</span><br />
174 Revokes the access_token and deletes the store if available.</td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]184 <tr>
185 <td colspan="2" class="summary">
186 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
187 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
188 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]189 <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]190 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
191 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
192 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]193 <code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]194 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
195 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
196 </p>
197 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
198 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]199 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]200 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
201 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,
202 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
203 </p></div>
204 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
205 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
206 </p></div>
207 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
208 <code>__delattr__</code>,
209 <code>__format__</code>,
210 <code>__getattribute__</code>,
211 <code>__hash__</code>,
212 <code>__new__</code>,
213 <code>__reduce__</code>,
214 <code>__reduce_ex__</code>,
215 <code>__repr__</code>,
216 <code>__setattr__</code>,
217 <code>__sizeof__</code>,
218 <code>__str__</code>,
219 <code>__subclasshook__</code>
220 </p>
221 </td>
222 </tr>
223</table>
224<!-- ==================== CLASS METHODS ==================== -->
225<a name="section-ClassMethods"></a>
226<table class="summary" border="1" cellpadding="3"
227 cellspacing="0" width="100%" bgcolor="white">
228<tr bgcolor="#70b0f0" class="table-header">
229 <td colspan="2" class="table-header">
230 <table border="0" cellpadding="0" cellspacing="0" width="100%">
231 <tr valign="top">
232 <td align="left"><span class="table-header">Class Methods</span></td>
233 <td align="right" valign="top"
234 ><span class="options">[<a href="#section-ClassMethods"
235 class="privatelink" onclick="toggle_private();"
236 >hide private</a>]</span></td>
237 </tr>
238 </table>
239 </td>
240</tr>
241 <tr>
242 <td colspan="2" class="summary">
243 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
244 <code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>
245 </p>
246 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
247 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
248 </p>
249 </td>
250 </tr>
251</table>
252<!-- ==================== CLASS VARIABLES ==================== -->
253<a name="section-ClassVariables"></a>
254<table class="summary" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256<tr bgcolor="#70b0f0" class="table-header">
257 <td colspan="2" class="table-header">
258 <table border="0" cellpadding="0" cellspacing="0" width="100%">
259 <tr valign="top">
260 <td align="left"><span class="table-header">Class Variables</span></td>
261 <td align="right" valign="top"
262 ><span class="options">[<a href="#section-ClassVariables"
263 class="privatelink" onclick="toggle_private();"
264 >hide private</a>]</span></td>
265 </tr>
266 </table>
267 </td>
268</tr>
269 <tr>
270 <td colspan="2" class="summary">
271 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
272 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
273 </p>
274 </td>
275 </tr>
276</table>
277<!-- ==================== PROPERTIES ==================== -->
278<a name="section-Properties"></a>
279<table class="summary" border="1" cellpadding="3"
280 cellspacing="0" width="100%" bgcolor="white">
281<tr bgcolor="#70b0f0" class="table-header">
282 <td colspan="2" class="table-header">
283 <table border="0" cellpadding="0" cellspacing="0" width="100%">
284 <tr valign="top">
285 <td align="left"><span class="table-header">Properties</span></td>
286 <td align="right" valign="top"
287 ><span class="options">[<a href="#section-Properties"
288 class="privatelink" onclick="toggle_private();"
289 >hide private</a>]</span></td>
290 </tr>
291 </table>
292 </td>
293</tr>
294 <tr>
295 <td colspan="2" class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]296 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
297 <code>__class__</code>
298 </p>
299 </td>
300 </tr>
301</table>
302<!-- ==================== METHOD DETAILS ==================== -->
303<a name="section-MethodDetails"></a>
304<table class="details" border="1" cellpadding="3"
305 cellspacing="0" width="100%" bgcolor="white">
306<tr bgcolor="#70b0f0" class="table-header">
307 <td colspan="2" class="table-header">
308 <table border="0" cellpadding="0" cellspacing="0" width="100%">
309 <tr valign="top">
310 <td align="left"><span class="table-header">Method Details</span></td>
311 <td align="right" valign="top"
312 ><span class="options">[<a href="#section-MethodDetails"
313 class="privatelink" onclick="toggle_private();"
314 >hide private</a>]</span></td>
315 </tr>
316 </table>
317 </td>
318</tr>
319</table>
320<a name="__init__"></a>
321<div>
322<table class="details" border="1" cellpadding="3"
323 cellspacing="0" width="100%" bgcolor="white">
324<tr><td>
325 <table width="100%" cellpadding="0" cellspacing="0" border="0">
326 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]327 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
328 <span class="sig-arg">assertion_type</span>,
329 <span class="sig-arg">user_agent</span>=<span class="sig-default">None</span>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]330 <span class="sig-arg">token_uri</span>=<span class="sig-default">GOOGLE_TOKEN_URI</span>,
331 <span class="sig-arg">revoke_uri</span>=<span class="sig-default">GOOGLE_REVOKE_URI</span>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]332 <span class="sig-arg">**unused_kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]333 <br /><em class="fname">(Constructor)</em>
334 </h3>
335 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]336 ><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]337 </td>
338 </tr></table>
339
340 <pre class="literalblock">
341Constructor for AssertionFlowCredentials.
342
343Args:
344 assertion_type: string, assertion type that will be declared to the auth
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]345 server
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]346 user_agent: string, The HTTP User-Agent to provide for this application.
347 token_uri: string, URI for token endpoint. For convenience
348 defaults to Google's endpoints but any OAuth 2.0 provider can be used.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]349 revoke_uri: string, URI for revoke endpoint.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]350
351</pre>
352 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]353 <dt>Decorators:</dt>
354 <dd><ul class="nomargin-top">
355 <li><code>@util.positional(2)</code></li>
356 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]357 <dt>Overrides:
358 object.__init__
359 </dt>
360 </dl>
361</td></tr></table>
362</div>
363<a name="_generate_refresh_request_body"></a>
364<div class="private">
365<table class="details" border="1" cellpadding="3"
366 cellspacing="0" width="100%" bgcolor="white">
367<tr><td>
368 <table width="100%" cellpadding="0" cellspacing="0" border="0">
369 <tr valign="top"><td>
370 <h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span>
371 </h3>
372 </td><td align="right" valign="top"
373 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source&nbsp;code</a></span>&nbsp;
374 </td>
375 </tr></table>
376
377 <pre class="literalblock">
378Generate the body that will be used in the refresh request.
379
380</pre>
381 <dl class="fields">
382 <dt>Overrides:
383 <a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a>
384 <dd><em class="note">(inherited documentation)</em></dd>
385 </dt>
386 </dl>
387</td></tr></table>
388</div>
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]389<a name="_revoke"></a>
390<div class="private">
391<table class="details" border="1" cellpadding="3"
392 cellspacing="0" width="100%" bgcolor="white">
393<tr><td>
394 <table width="100%" cellpadding="0" cellspacing="0" border="0">
395 <tr valign="top"><td>
396 <h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>,
397 <span class="sig-arg">http_request</span>)</span>
398 </h3>
399 </td><td align="right" valign="top"
400 ><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source&nbsp;code</a></span>&nbsp;
401 </td>
402 </tr></table>
403
404 <pre class="literalblock">
405Revokes the access_token and deletes the store if available.
406
407Args:
408 http_request: callable, a callable that matches the method signature of
409 httplib2.Http.request, used to make the revoke request.
410
411</pre>
412 <dl class="fields">
413 <dt>Overrides:
414 <a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a>
415 </dt>
416 </dl>
417</td></tr></table>
418</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]419<br />
420<!-- ==================== NAVIGATION BAR ==================== -->
421<table class="navbar" border="0" width="100%" cellpadding="0"
422 bgcolor="#a0c0ff" cellspacing="0">
423 <tr valign="middle">
424
425 <!-- Tree link -->
426 <th>&nbsp;&nbsp;&nbsp;<a
427 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
428
429 <!-- Index link -->
430 <th>&nbsp;&nbsp;&nbsp;<a
431 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
432
433 <!-- Help link -->
434 <th>&nbsp;&nbsp;&nbsp;<a
435 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
436
437 <th class="navbar" width="100%"></th>
438 </tr>
439</table>
440<table border="0" cellpadding="0" cellspacing="0" width="100%%">
441 <tr>
442 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]443 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:45 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]444 </td>
445 <td align="right" class="footer">
446 <a target="mainFrame" href="http://epydoc.sourceforge.net"
447 >http://epydoc.sourceforge.net</a>
448 </td>
449 </tr>
450</table>
451
452<script type="text/javascript">
453 <!--
454 // Private objects are initially displayed (because if
455 // javascript is turned off then we want them to be
456 // visible); but by default, we want to hide them. So hide
457 // them unless we have a cookie that says to show them.
458 checkCookie();
459 // -->
460</script>
461</body>
462</html>