| OLD | NEW |
|---|
| (Empty) | |
| 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</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> <a |
| 20 href="module-tree.html">Trees</a> </th> |
| 21 |
| 22 <!-- Index link --> |
| 23 <th> <a |
| 24 href="identifier-index.html">Indices</a> </th> |
| 25 |
| 26 <!-- Help link --> |
| 27 <th> <a |
| 28 href="help.html">Help</a> </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 oauth2client</a> :: |
| 38 Module client |
| 39 </span> |
| 40 </td> |
| 41 <td> |
| 42 <table cellpadding="0" cellspacing="0"> |
| 43 <!-- hide/show private --> |
| 44 <tr><td align="right"><span class="options">[<a href="javascript:void(0)
;" class="privatelink" |
| 45 onclick="toggle_private();">hide private</a>]</span></td></tr> |
| 46 <tr><td align="right"><span class="options" |
| 47 >[<a href="frames.html" target="_top">frames</a |
| 48 >] | <a href="oauth2client.client-module.html" |
| 49 target="_top">no frames</a>]</span></td></tr> |
| 50 </table> |
| 51 </td> |
| 52 </tr> |
| 53 </table> |
| 54 <!-- ==================== MODULE DESCRIPTION ==================== --> |
| 55 <h1 class="epydoc">Module client</h1><p class="nomargin-top"><span class="codeli
nk"><a href="oauth2client.client-pysrc.html">source code</a></span></p> |
| 56 <pre class="literalblock"> |
| 57 An OAuth 2.0 client. |
| 58 |
| 59 Tools for interacting with OAuth 2.0 protected resources. |
| 60 |
| 61 </pre> |
| 62 |
| 63 <hr /> |
| 64 <div class="fields"> <p><strong>Author:</strong> |
| 65 jcgregorio@google.com (Joe Gregorio) |
| 66 </p> |
| 67 </div><!-- ==================== CLASSES ==================== --> |
| 68 <a name="section-Classes"></a> |
| 69 <table class="summary" border="1" cellpadding="3" |
| 70 cellspacing="0" width="100%" bgcolor="white"> |
| 71 <tr bgcolor="#70b0f0" class="table-header"> |
| 72 <td colspan="2" class="table-header"> |
| 73 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 74 <tr valign="top"> |
| 75 <td align="left"><span class="table-header">Classes</span></td> |
| 76 <td align="right" valign="top" |
| 77 ><span class="options">[<a href="#section-Classes" |
| 78 class="privatelink" onclick="toggle_private();" |
| 79 >hide private</a>]</span></td> |
| 80 </tr> |
| 81 </table> |
| 82 </td> |
| 83 </tr> |
| 84 <tr> |
| 85 <td width="15%" align="right" valign="top" class="summary"> |
| 86 <span class="summary-type"> </span> |
| 87 </td><td class="summary"> |
| 88 <a href="oauth2client.client.Error-class.html" class="summary-name">Erro
r</a><br /> |
| 89 Base error for this module. |
| 90 </td> |
| 91 </tr> |
| 92 <tr> |
| 93 <td width="15%" align="right" valign="top" class="summary"> |
| 94 <span class="summary-type"> </span> |
| 95 </td><td class="summary"> |
| 96 <a href="oauth2client.client.FlowExchangeError-class.html" class="summar
y-name">FlowExchangeError</a><br /> |
| 97 Error trying to exchange an authorization grant for an access token. |
| 98 </td> |
| 99 </tr> |
| 100 <tr> |
| 101 <td width="15%" align="right" valign="top" class="summary"> |
| 102 <span class="summary-type"> </span> |
| 103 </td><td class="summary"> |
| 104 <a href="oauth2client.client.AccessTokenRefreshError-class.html" class="
summary-name">AccessTokenRefreshError</a><br /> |
| 105 Error trying to refresh an expired access token. |
| 106 </td> |
| 107 </tr> |
| 108 <tr> |
| 109 <td width="15%" align="right" valign="top" class="summary"> |
| 110 <span class="summary-type"> </span> |
| 111 </td><td class="summary"> |
| 112 <a href="oauth2client.client.UnknownClientSecretsFlowError-class.html" c
lass="summary-name">UnknownClientSecretsFlowError</a><br /> |
| 113 The client secrets file called for an unknown type of OAuth 2.0 flow. |
| 114 </td> |
| 115 </tr> |
| 116 <tr> |
| 117 <td width="15%" align="right" valign="top" class="summary"> |
| 118 <span class="summary-type"> </span> |
| 119 </td><td class="summary"> |
| 120 <a href="oauth2client.client.AccessTokenCredentialsError-class.html" cla
ss="summary-name">AccessTokenCredentialsError</a><br /> |
| 121 Having only the access_token means no refresh is possible. |
| 122 </td> |
| 123 </tr> |
| 124 <tr> |
| 125 <td width="15%" align="right" valign="top" class="summary"> |
| 126 <span class="summary-type"> </span> |
| 127 </td><td class="summary"> |
| 128 <a href="oauth2client.client.VerifyJwtTokenError-class.html" class="summ
ary-name">VerifyJwtTokenError</a><br /> |
| 129 Could on retrieve certificates for validation. |
| 130 </td> |
| 131 </tr> |
| 132 <tr> |
| 133 <td width="15%" align="right" valign="top" class="summary"> |
| 134 <span class="summary-type"> </span> |
| 135 </td><td class="summary"> |
| 136 <a href="oauth2client.client.MemoryCache-class.html" class="summary-name
">MemoryCache</a><br /> |
| 137 httplib2 Cache implementation which only caches locally. |
| 138 </td> |
| 139 </tr> |
| 140 <tr> |
| 141 <td width="15%" align="right" valign="top" class="summary"> |
| 142 <span class="summary-type"> </span> |
| 143 </td><td class="summary"> |
| 144 <a href="oauth2client.client.Credentials-class.html" class="summary-name
">Credentials</a><br /> |
| 145 Base class for all Credentials objects. |
| 146 </td> |
| 147 </tr> |
| 148 <tr> |
| 149 <td width="15%" align="right" valign="top" class="summary"> |
| 150 <span class="summary-type"> </span> |
| 151 </td><td class="summary"> |
| 152 <a href="oauth2client.client.Flow-class.html" class="summary-name">Flow<
/a><br /> |
| 153 Base class for all Flow objects. |
| 154 </td> |
| 155 </tr> |
| 156 <tr> |
| 157 <td width="15%" align="right" valign="top" class="summary"> |
| 158 <span class="summary-type"> </span> |
| 159 </td><td class="summary"> |
| 160 <a href="oauth2client.client.Storage-class.html" class="summary-name">St
orage</a><br /> |
| 161 Base class for all Storage objects. |
| 162 </td> |
| 163 </tr> |
| 164 <tr> |
| 165 <td width="15%" align="right" valign="top" class="summary"> |
| 166 <span class="summary-type"> </span> |
| 167 </td><td class="summary"> |
| 168 <a href="oauth2client.client.OAuth2Credentials-class.html" class="summar
y-name">OAuth2Credentials</a><br /> |
| 169 Credentials object for OAuth 2.0. |
| 170 </td> |
| 171 </tr> |
| 172 <tr> |
| 173 <td width="15%" align="right" valign="top" class="summary"> |
| 174 <span class="summary-type"> </span> |
| 175 </td><td class="summary"> |
| 176 <a href="oauth2client.client.AccessTokenCredentials-class.html" class="s
ummary-name">AccessTokenCredentials</a><br /> |
| 177 Credentials object for OAuth 2.0. |
| 178 </td> |
| 179 </tr> |
| 180 <tr> |
| 181 <td width="15%" align="right" valign="top" class="summary"> |
| 182 <span class="summary-type"> </span> |
| 183 </td><td class="summary"> |
| 184 <a href="oauth2client.client.AssertionCredentials-class.html" class="sum
mary-name">AssertionCredentials</a><br /> |
| 185 Abstract Credentials object used for OAuth 2.0 assertion grants. |
| 186 </td> |
| 187 </tr> |
| 188 <tr> |
| 189 <td width="15%" align="right" valign="top" class="summary"> |
| 190 <span class="summary-type"> </span> |
| 191 </td><td class="summary"> |
| 192 <a href="oauth2client.client.SignedJwtAssertionCredentials-class.html" c
lass="summary-name">SignedJwtAssertionCredentials</a><br /> |
| 193 Credentials object used for OAuth 2.0 Signed JWT assertion grants. |
| 194 </td> |
| 195 </tr> |
| 196 <tr> |
| 197 <td width="15%" align="right" valign="top" class="summary"> |
| 198 <span class="summary-type"> </span> |
| 199 </td><td class="summary"> |
| 200 <a href="oauth2client.client.OAuth2WebServerFlow-class.html" class="summ
ary-name">OAuth2WebServerFlow</a><br /> |
| 201 Does the Web Server Flow for OAuth 2.0. |
| 202 </td> |
| 203 </tr> |
| 204 </table> |
| 205 <!-- ==================== FUNCTIONS ==================== --> |
| 206 <a name="section-Functions"></a> |
| 207 <table class="summary" border="1" cellpadding="3" |
| 208 cellspacing="0" width="100%" bgcolor="white"> |
| 209 <tr bgcolor="#70b0f0" class="table-header"> |
| 210 <td colspan="2" class="table-header"> |
| 211 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 212 <tr valign="top"> |
| 213 <td align="left"><span class="table-header">Functions</span></td> |
| 214 <td align="right" valign="top" |
| 215 ><span class="options">[<a href="#section-Functions" |
| 216 class="privatelink" onclick="toggle_private();" |
| 217 >hide private</a>]</span></td> |
| 218 </tr> |
| 219 </table> |
| 220 </td> |
| 221 </tr> |
| 222 <tr class="private"> |
| 223 <td width="15%" align="right" valign="top" class="summary"> |
| 224 <span class="summary-type"> </span> |
| 225 </td><td class="summary"> |
| 226 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 227 <tr> |
| 228 <td><span class="summary-sig"><a name="_abstract"></a><span class="sum
mary-sig-name">_abstract</span>()</span></td> |
| 229 <td align="right" valign="top"> |
| 230 <span class="codelink"><a href="oauth2client.client-pysrc.html#_abst
ract">source code</a></span> |
| 231 ············ |
| 232 </td> |
| 233 </tr> |
| 234 </table> |
| 235 ······ |
| 236 </td> |
| 237 </tr> |
| 238 <tr> |
| 239 <td width="15%" align="right" valign="top" class="summary"> |
| 240 <span class="summary-type"> </span> |
| 241 </td><td class="summary"> |
| 242 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 243 <tr> |
| 244 <td><span class="summary-sig"><a href="oauth2client.client-module.html
#verify_id_token" class="summary-sig-name">verify_id_token</a>(<span class="summ
ary-sig-arg">id_token</span>, |
| 245 <span class="summary-sig-arg">audience</span>, |
| 246 <span class="summary-sig-arg">http</span>=<span class="summary-sig-defau
lt">None</span>, |
| 247 <span class="summary-sig-arg">cert_uri</span>=<span class="summary-sig-d
efault"><code class="variable-quote">'</code><code class="variable-string">https
://www.googleapis.com/oauth2/v1/certs</code><code class="variable-quote">'</code
></span>)</span><br /> |
| 248 Verifies a signed JWT id_token.</td> |
| 249 <td align="right" valign="top"> |
| 250 <span class="codelink"><a href="oauth2client.client-pysrc.html#verif
y_id_token">source code</a></span> |
| 251 ············ |
| 252 </td> |
| 253 </tr> |
| 254 </table> |
| 255 ······ |
| 256 </td> |
| 257 </tr> |
| 258 <tr class="private"> |
| 259 <td width="15%" align="right" valign="top" class="summary"> |
| 260 <span class="summary-type"> </span> |
| 261 </td><td class="summary"> |
| 262 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 263 <tr> |
| 264 <td><span class="summary-sig"><a name="_urlsafe_b64decode"></a><span c
lass="summary-sig-name">_urlsafe_b64decode</span>(<span class="summary-sig-arg">
b64string</span>)</span></td> |
| 265 <td align="right" valign="top"> |
| 266 <span class="codelink"><a href="oauth2client.client-pysrc.html#_urls
afe_b64decode">source code</a></span> |
| 267 ············ |
| 268 </td> |
| 269 </tr> |
| 270 </table> |
| 271 ······ |
| 272 </td> |
| 273 </tr> |
| 274 <tr class="private"> |
| 275 <td width="15%" align="right" valign="top" class="summary"> |
| 276 <span class="summary-type"> </span> |
| 277 </td><td class="summary"> |
| 278 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 279 <tr> |
| 280 <td><span class="summary-sig"><a href="oauth2client.client-module.html
#_extract_id_token" class="summary-sig-name" onclick="show_private();">_extract_
id_token</a>(<span class="summary-sig-arg">id_token</span>)</span><br /> |
| 281 Extract the JSON payload from a JWT.</td> |
| 282 <td align="right" valign="top"> |
| 283 <span class="codelink"><a href="oauth2client.client-pysrc.html#_extr
act_id_token">source code</a></span> |
| 284 ············ |
| 285 </td> |
| 286 </tr> |
| 287 </table> |
| 288 ······ |
| 289 </td> |
| 290 </tr> |
| 291 <tr> |
| 292 <td width="15%" align="right" valign="top" class="summary"> |
| 293 <span class="summary-type"> </span> |
| 294 </td><td class="summary"> |
| 295 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 296 <tr> |
| 297 <td><span class="summary-sig"><a href="oauth2client.client-module.html
#flow_from_clientsecrets" class="summary-sig-name">flow_from_clientsecrets</a>(<
span class="summary-sig-arg">filename</span>, |
| 298 <span class="summary-sig-arg">scope</span>, |
| 299 <span class="summary-sig-arg">message</span>=<span class="summary-sig-de
fault">None</span>)</span><br /> |
| 300 Create a Flow from a clientsecrets file.</td> |
| 301 <td align="right" valign="top"> |
| 302 <span class="codelink"><a href="oauth2client.client-pysrc.html#flow_
from_clientsecrets">source code</a></span> |
| 303 ············ |
| 304 </td> |
| 305 </tr> |
| 306 </table> |
| 307 ······ |
| 308 </td> |
| 309 </tr> |
| 310 </table> |
| 311 <!-- ==================== VARIABLES ==================== --> |
| 312 <a name="section-Variables"></a> |
| 313 <table class="summary" border="1" cellpadding="3" |
| 314 cellspacing="0" width="100%" bgcolor="white"> |
| 315 <tr bgcolor="#70b0f0" class="table-header"> |
| 316 <td colspan="2" class="table-header"> |
| 317 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 318 <tr valign="top"> |
| 319 <td align="left"><span class="table-header">Variables</span></td> |
| 320 <td align="right" valign="top" |
| 321 ><span class="options">[<a href="#section-Variables" |
| 322 class="privatelink" onclick="toggle_private();" |
| 323 >hide private</a>]</span></td> |
| 324 </tr> |
| 325 </table> |
| 326 </td> |
| 327 </tr> |
| 328 <tr> |
| 329 <td width="15%" align="right" valign="top" class="summary"> |
| 330 <span class="summary-type"> </span> |
| 331 </td><td class="summary"> |
| 332 <a name="HAS_OPENSSL"></a><span class="summary-name">HAS_OPENSSL</span>
= <code title="True">True</code> |
| 333 </td> |
| 334 </tr> |
| 335 <tr> |
| 336 <td width="15%" align="right" valign="top" class="summary"> |
| 337 <span class="summary-type"> </span> |
| 338 </td><td class="summary"> |
| 339 <a name="logger"></a><span class="summary-name">logger</span> = <code ti
tle="logging.getLogger(__name__)">logging.getLogger(__name__)</code> |
| 340 </td> |
| 341 </tr> |
| 342 <tr> |
| 343 <td width="15%" align="right" valign="top" class="summary"> |
| 344 <span class="summary-type"> </span> |
| 345 </td><td class="summary"> |
| 346 <a name="EXPIRY_FORMAT"></a><span class="summary-name">EXPIRY_FORMAT</sp
an> = <code title="'%Y-%m-%dT%H:%M:%SZ'"><code class="variable-quote">'</code><c
ode class="variable-string">%Y-%m-%dT%H:%M:%SZ</code><code class="variable-quote
">'</code></code> |
| 347 </td> |
| 348 </tr> |
| 349 <tr> |
| 350 <td width="15%" align="right" valign="top" class="summary"> |
| 351 <span class="summary-type"> </span> |
| 352 </td><td class="summary"> |
| 353 <a href="oauth2client.client-module.html#ID_TOKEN_VERIFICATON_CERTS" cla
ss="summary-name">ID_TOKEN_VERIFICATON_CERTS</a> = <code title="'https://www.goo
gleapis.com/oauth2/v1/certs'"><code class="variable-quote">'</code><code class="
variable-string">https://www.googleapis.com/oauth</code><code class="variable-el
lipsis">...</code></code> |
| 354 </td> |
| 355 </tr> |
| 356 <tr> |
| 357 <td width="15%" align="right" valign="top" class="summary"> |
| 358 <span class="summary-type"> </span> |
| 359 </td><td class="summary"> |
| 360 <a name="OOB_CALLBACK_URN"></a><span class="summary-name">OOB_CALLBACK_U
RN</span> = <code title="'urn:ietf:wg:oauth:2.0:oob'"><code class="variable-quot
e">'</code><code class="variable-string">urn:ietf:wg:oauth:2.0:oob</code><code c
lass="variable-quote">'</code></code> |
| 361 </td> |
| 362 </tr> |
| 363 <tr class="private"> |
| 364 <td width="15%" align="right" valign="top" class="summary"> |
| 365 <span class="summary-type"> </span> |
| 366 </td><td class="summary"> |
| 367 <a name="_cached_http"></a><span class="summary-name">_cached_http</span
> = <code title="httplib2.Http(MemoryCache())">httplib2.Http(MemoryCache())</cod
e> |
| 368 </td> |
| 369 </tr> |
| 370 <tr> |
| 371 <td width="15%" align="right" valign="top" class="summary"> |
| 372 <span class="summary-type"> </span> |
| 373 </td><td class="summary"> |
| 374 <a name="__package__"></a><span class="summary-name">__package__</span>
= <code title="'oauth2client'"><code class="variable-quote">'</code><code class=
"variable-string">oauth2client</code><code class="variable-quote">'</code></code
> |
| 375 </td> |
| 376 </tr> |
| 377 </table> |
| 378 <!-- ==================== FUNCTION DETAILS ==================== --> |
| 379 <a name="section-FunctionDetails"></a> |
| 380 <table class="details" border="1" cellpadding="3" |
| 381 cellspacing="0" width="100%" bgcolor="white"> |
| 382 <tr bgcolor="#70b0f0" class="table-header"> |
| 383 <td colspan="2" class="table-header"> |
| 384 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 385 <tr valign="top"> |
| 386 <td align="left"><span class="table-header">Function Details</span></td> |
| 387 <td align="right" valign="top" |
| 388 ><span class="options">[<a href="#section-FunctionDetails" |
| 389 class="privatelink" onclick="toggle_private();" |
| 390 >hide private</a>]</span></td> |
| 391 </tr> |
| 392 </table> |
| 393 </td> |
| 394 </tr> |
| 395 </table> |
| 396 <a name="verify_id_token"></a> |
| 397 <div> |
| 398 <table class="details" border="1" cellpadding="3" |
| 399 cellspacing="0" width="100%" bgcolor="white"> |
| 400 <tr><td> |
| 401 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 402 <tr valign="top"><td> |
| 403 <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_id_token</s
pan>(<span class="sig-arg">id_token</span>, |
| 404 <span class="sig-arg">audience</span>, |
| 405 <span class="sig-arg">http</span>=<span class="sig-default">None</span>, |
| 406 <span class="sig-arg">cert_uri</span>=<span class="sig-default"><code cl
ass="variable-quote">'</code><code class="variable-string">https://www.googleapi
s.com/oauth2/v1/certs</code><code class="variable-quote">'</code></span>)</span> |
| 407 </h3> |
| 408 </td><td align="right" valign="top" |
| 409 ><span class="codelink"><a href="oauth2client.client-pysrc.html#verify_id_to
ken">source code</a></span> |
| 410 </td> |
| 411 </tr></table> |
| 412 ·· |
| 413 <pre class="literalblock"> |
| 414 Verifies a signed JWT id_token. |
| 415 |
| 416 Args: |
| 417 id_token: string, A Signed JWT. |
| 418 audience: string, The audience 'aud' that the token should be for. |
| 419 http: httplib2.Http, instance to use to make the HTTP request. Callers |
| 420 should supply an instance that has caching enabled. |
| 421 cert_uri: string, URI of the certificates in JSON format to |
| 422 verify the JWT against. |
| 423 |
| 424 Returns: |
| 425 The deserialized JSON in the JWT. |
| 426 |
| 427 Raises: |
| 428 oauth2client.crypt.AppIdentityError if the JWT fails to verify. |
| 429 |
| 430 </pre> |
| 431 <dl class="fields"> |
| 432 </dl> |
| 433 </td></tr></table> |
| 434 </div> |
| 435 <a name="_extract_id_token"></a> |
| 436 <div class="private"> |
| 437 <table class="details" border="1" cellpadding="3" |
| 438 cellspacing="0" width="100%" bgcolor="white"> |
| 439 <tr><td> |
| 440 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 441 <tr valign="top"><td> |
| 442 <h3 class="epydoc"><span class="sig"><span class="sig-name">_extract_id_token<
/span>(<span class="sig-arg">id_token</span>)</span> |
| 443 </h3> |
| 444 </td><td align="right" valign="top" |
| 445 ><span class="codelink"><a href="oauth2client.client-pysrc.html#_extract_id_
token">source code</a></span> |
| 446 </td> |
| 447 </tr></table> |
| 448 ·· |
| 449 <pre class="literalblock"> |
| 450 Extract the JSON payload from a JWT. |
| 451 |
| 452 Does the extraction w/o checking the signature. |
| 453 |
| 454 Args: |
| 455 id_token: string, OAuth 2.0 id_token. |
| 456 |
| 457 Returns: |
| 458 object, The deserialized JSON payload. |
| 459 |
| 460 </pre> |
| 461 <dl class="fields"> |
| 462 </dl> |
| 463 </td></tr></table> |
| 464 </div> |
| 465 <a name="flow_from_clientsecrets"></a> |
| 466 <div> |
| 467 <table class="details" border="1" cellpadding="3" |
| 468 cellspacing="0" width="100%" bgcolor="white"> |
| 469 <tr><td> |
| 470 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 471 <tr valign="top"><td> |
| 472 <h3 class="epydoc"><span class="sig"><span class="sig-name">flow_from_clientse
crets</span>(<span class="sig-arg">filename</span>, |
| 473 <span class="sig-arg">scope</span>, |
| 474 <span class="sig-arg">message</span>=<span class="sig-default">None</spa
n>)</span> |
| 475 </h3> |
| 476 </td><td align="right" valign="top" |
| 477 ><span class="codelink"><a href="oauth2client.client-pysrc.html#flow_from_cl
ientsecrets">source code</a></span> |
| 478 </td> |
| 479 </tr></table> |
| 480 ·· |
| 481 <pre class="literalblock"> |
| 482 Create a Flow from a clientsecrets file. |
| 483 |
| 484 Will create the right kind of Flow based on the contents of the clientsecrets |
| 485 file or will raise InvalidClientSecretsError for unknown types of Flows. |
| 486 |
| 487 Args: |
| 488 filename: string, File name of client secrets. |
| 489 scope: string or list of strings, scope(s) to request. |
| 490 message: string, A friendly string to display to the user if the |
| 491 clientsecrets file is missing or invalid. If message is provided then |
| 492 sys.exit will be called in the case of an error. If message in not |
| 493 provided then clientsecrets.InvalidClientSecretsError will be raised. |
| 494 |
| 495 Returns: |
| 496 A Flow object. |
| 497 |
| 498 Raises: |
| 499 UnknownClientSecretsFlowError if the file describes an unknown kind of Flow. |
| 500 clientsecrets.InvalidClientSecretsError if the clientsecrets file is |
| 501 invalid. |
| 502 |
| 503 </pre> |
| 504 <dl class="fields"> |
| 505 </dl> |
| 506 </td></tr></table> |
| 507 </div> |
| 508 <br /> |
| 509 <!-- ==================== VARIABLES DETAILS ==================== --> |
| 510 <a name="section-VariablesDetails"></a> |
| 511 <table class="details" border="1" cellpadding="3" |
| 512 cellspacing="0" width="100%" bgcolor="white"> |
| 513 <tr bgcolor="#70b0f0" class="table-header"> |
| 514 <td colspan="2" class="table-header"> |
| 515 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 516 <tr valign="top"> |
| 517 <td align="left"><span class="table-header">Variables Details</span></td
> |
| 518 <td align="right" valign="top" |
| 519 ><span class="options">[<a href="#section-VariablesDetails" |
| 520 class="privatelink" onclick="toggle_private();" |
| 521 >hide private</a>]</span></td> |
| 522 </tr> |
| 523 </table> |
| 524 </td> |
| 525 </tr> |
| 526 </table> |
| 527 <a name="ID_TOKEN_VERIFICATON_CERTS"></a> |
| 528 <div> |
| 529 <table class="details" border="1" cellpadding="3" |
| 530 cellspacing="0" width="100%" bgcolor="white"> |
| 531 <tr><td> |
| 532 <h3 class="epydoc">ID_TOKEN_VERIFICATON_CERTS</h3> |
| 533 ·· |
| 534 <dl class="fields"> |
| 535 </dl> |
| 536 <dl class="fields"> |
| 537 <dt>Value:</dt> |
| 538 <dd><table><tr><td><pre class="variable"> |
| 539 <code class="variable-quote">'</code><code class="variable-string">https://www.g
oogleapis.com/oauth2/v1/certs</code><code class="variable-quote">'</code> |
| 540 </pre></td></tr></table> |
| 541 </dd> |
| 542 </dl> |
| 543 </td></tr></table> |
| 544 </div> |
| 545 <br /> |
| 546 <!-- ==================== NAVIGATION BAR ==================== --> |
| 547 <table class="navbar" border="0" width="100%" cellpadding="0" |
| 548 bgcolor="#a0c0ff" cellspacing="0"> |
| 549 <tr valign="middle"> |
| 550 |
| 551 <!-- Tree link --> |
| 552 <th> <a |
| 553 href="module-tree.html">Trees</a> </th> |
| 554 |
| 555 <!-- Index link --> |
| 556 <th> <a |
| 557 href="identifier-index.html">Indices</a> </th> |
| 558 |
| 559 <!-- Help link --> |
| 560 <th> <a |
| 561 href="help.html">Help</a> </th> |
| 562 |
| 563 <th class="navbar" width="100%"></th> |
| 564 </tr> |
| 565 </table> |
| 566 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 567 <tr> |
| 568 <td align="left" class="footer"> |
| 569 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 |
| 570 </td> |
| 571 <td align="right" class="footer"> |
| 572 <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 573 >http://epydoc.sourceforge.net</a> |
| 574 </td> |
| 575 </tr> |
| 576 </table> |
| 577 |
| 578 <script type="text/javascript"> |
| 579 <!-- |
| 580 // Private objects are initially displayed (because if |
| 581 // javascript is turned off then we want them to be |
| 582 // visible); but by default, we want to hide them. So hide |
| 583 // them unless we have a cookie that says to show them. |
| 584 checkCookie(); |
| 585 // --> |
| 586 </script> |
| 587 </body> |
| 588 </html> |
| OLD | NEW |
|---|
