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