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