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