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