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