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