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>googleapiclient._auth</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 <!-- Home link --> 18 <th> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </th> 32 33 <th class="navbar" width="100%"></th> 34 </tr> 35</table> 36<table width="100%" cellpadding="0" cellspacing="0"> 37 <tr valign="top"> 38 <td width="100%"> 39 <span class="breadcrumbs"> 40 <a href="googleapiclient-module.html">Package googleapiclient</a> :: 41 Module _auth 42 </span> 43 </td> 44 <td> 45 <table cellpadding="0" cellspacing="0"> 46 <!-- hide/show private --> 47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 48 onclick="toggle_private();">hide private</a>]</span></td></tr> 49 <tr><td align="right"><span class="options" 50 >[<a href="frames.html" target="_top">frames</a 51 >] | <a href="googleapiclient._auth-module.html" 52 target="_top">no frames</a>]</span></td></tr> 53 </table> 54 </td> 55 </tr> 56</table> 57<!-- ==================== MODULE DESCRIPTION ==================== --> 58<h1 class="epydoc">Module _auth</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient._auth-pysrc.html">source code</a></span></p> 59<p>Helpers for authentication using oauth2client or google-auth.</p> 60 61<!-- ==================== FUNCTIONS ==================== --> 62<a name="section-Functions"></a> 63<table class="summary" border="1" cellpadding="3" 64 cellspacing="0" width="100%" bgcolor="white"> 65<tr bgcolor="#70b0f0" class="table-header"> 66 <td colspan="2" class="table-header"> 67 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 68 <tr valign="top"> 69 <td align="left"><span class="table-header">Functions</span></td> 70 <td align="right" valign="top" 71 ><span class="options">[<a href="#section-Functions" 72 class="privatelink" onclick="toggle_private();" 73 >hide private</a>]</span></td> 74 </tr> 75 </table> 76 </td> 77</tr> 78<tr> 79 <td width="15%" align="right" valign="top" class="summary"> 80 <span class="summary-type"> </span> 81 </td><td class="summary"> 82 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 83 <tr> 84 <td><span class="summary-sig"><a name="credentials_from_file"></a><span class="summary-sig-name">credentials_from_file</span>(<span class="summary-sig-arg">filename</span>, 85 <span class="summary-sig-arg">scopes</span>=<span class="summary-sig-default">None</span>, 86 <span class="summary-sig-arg">quota_project_id</span>=<span class="summary-sig-default">None</span>)</span><br /> 87 Returns credentials loaded from a file.</td> 88 <td align="right" valign="top"> 89 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#credentials_from_file">source code</a></span> 90 91 </td> 92 </tr> 93 </table> 94 95 </td> 96 </tr> 97<tr> 98 <td width="15%" align="right" valign="top" class="summary"> 99 <span class="summary-type"> </span> 100 </td><td class="summary"> 101 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 102 <tr> 103 <td><span class="summary-sig"><a name="default_credentials"></a><span class="summary-sig-name">default_credentials</span>(<span class="summary-sig-arg">scopes</span>=<span class="summary-sig-default">None</span>, 104 <span class="summary-sig-arg">quota_project_id</span>=<span class="summary-sig-default">None</span>)</span><br /> 105 Returns Application Default Credentials.</td> 106 <td align="right" valign="top"> 107 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#default_credentials">source code</a></span> 108 109 </td> 110 </tr> 111 </table> 112 113 </td> 114 </tr> 115<tr> 116 <td width="15%" align="right" valign="top" class="summary"> 117 <span class="summary-type"> </span> 118 </td><td class="summary"> 119 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 120 <tr> 121 <td><span class="summary-sig"><a href="googleapiclient._auth-module.html#with_scopes" class="summary-sig-name">with_scopes</a>(<span class="summary-sig-arg">credentials</span>, 122 <span class="summary-sig-arg">scopes</span>)</span><br /> 123 Scopes the credentials if necessary.</td> 124 <td align="right" valign="top"> 125 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#with_scopes">source code</a></span> 126 127 </td> 128 </tr> 129 </table> 130 131 </td> 132 </tr> 133<tr> 134 <td width="15%" align="right" valign="top" class="summary"> 135 <span class="summary-type"> </span> 136 </td><td class="summary"> 137 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 138 <tr> 139 <td><span class="summary-sig"><a href="googleapiclient._auth-module.html#authorized_http" class="summary-sig-name">authorized_http</a>(<span class="summary-sig-arg">credentials</span>)</span><br /> 140 Returns an http client that is authorized with the given credentials.</td> 141 <td align="right" valign="top"> 142 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#authorized_http">source code</a></span> 143 144 </td> 145 </tr> 146 </table> 147 148 </td> 149 </tr> 150<tr> 151 <td width="15%" align="right" valign="top" class="summary"> 152 <span class="summary-type"> </span> 153 </td><td class="summary"> 154 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 155 <tr> 156 <td><span class="summary-sig"><a name="refresh_credentials"></a><span class="summary-sig-name">refresh_credentials</span>(<span class="summary-sig-arg">credentials</span>)</span></td> 157 <td align="right" valign="top"> 158 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#refresh_credentials">source code</a></span> 159 160 </td> 161 </tr> 162 </table> 163 164 </td> 165 </tr> 166<tr> 167 <td width="15%" align="right" valign="top" class="summary"> 168 <span class="summary-type"> </span> 169 </td><td class="summary"> 170 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 171 <tr> 172 <td><span class="summary-sig"><a name="apply_credentials"></a><span class="summary-sig-name">apply_credentials</span>(<span class="summary-sig-arg">credentials</span>, 173 <span class="summary-sig-arg">headers</span>)</span></td> 174 <td align="right" valign="top"> 175 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#apply_credentials">source code</a></span> 176 177 </td> 178 </tr> 179 </table> 180 181 </td> 182 </tr> 183<tr> 184 <td width="15%" align="right" valign="top" class="summary"> 185 <span class="summary-type"> </span> 186 </td><td class="summary"> 187 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 188 <tr> 189 <td><span class="summary-sig"><a name="is_valid"></a><span class="summary-sig-name">is_valid</span>(<span class="summary-sig-arg">credentials</span>)</span></td> 190 <td align="right" valign="top"> 191 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#is_valid">source code</a></span> 192 193 </td> 194 </tr> 195 </table> 196 197 </td> 198 </tr> 199<tr> 200 <td width="15%" align="right" valign="top" class="summary"> 201 <span class="summary-type"> </span> 202 </td><td class="summary"> 203 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 204 <tr> 205 <td><span class="summary-sig"><a name="get_credentials_from_http"></a><span class="summary-sig-name">get_credentials_from_http</span>(<span class="summary-sig-arg">http</span>)</span></td> 206 <td align="right" valign="top"> 207 <span class="codelink"><a href="googleapiclient._auth-pysrc.html#get_credentials_from_http">source code</a></span> 208 209 </td> 210 </tr> 211 </table> 212 213 </td> 214 </tr> 215</table> 216<!-- ==================== VARIABLES ==================== --> 217<a name="section-Variables"></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">Variables</span></td> 225 <td align="right" valign="top" 226 ><span class="options">[<a href="#section-Variables" 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"> </span> 236 </td><td class="summary"> 237 <a name="HAS_GOOGLE_AUTH"></a><span class="summary-name">HAS_GOOGLE_AUTH</span> = <code title="False">False</code> 238 </td> 239 </tr> 240<tr> 241 <td width="15%" align="right" valign="top" class="summary"> 242 <span class="summary-type"> </span> 243 </td><td class="summary"> 244 <a name="google_auth_httplib2"></a><span class="summary-name">google_auth_httplib2</span> = <code title="None">None</code> 245 </td> 246 </tr> 247<tr> 248 <td width="15%" align="right" valign="top" class="summary"> 249 <span class="summary-type"> </span> 250 </td><td class="summary"> 251 <a name="HAS_OAUTH2CLIENT"></a><span class="summary-name">HAS_OAUTH2CLIENT</span> = <code title="False">False</code> 252 </td> 253 </tr> 254<tr> 255 <td width="15%" align="right" valign="top" class="summary"> 256 <span class="summary-type"> </span> 257 </td><td class="summary"> 258 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'googleapiclient'"><code class="variable-quote">'</code><code class="variable-string">googleapiclient</code><code class="variable-quote">'</code></code> 259 </td> 260 </tr> 261</table> 262<!-- ==================== FUNCTION DETAILS ==================== --> 263<a name="section-FunctionDetails"></a> 264<table class="details" border="1" cellpadding="3" 265 cellspacing="0" width="100%" bgcolor="white"> 266<tr bgcolor="#70b0f0" class="table-header"> 267 <td colspan="2" class="table-header"> 268 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 269 <tr valign="top"> 270 <td align="left"><span class="table-header">Function Details</span></td> 271 <td align="right" valign="top" 272 ><span class="options">[<a href="#section-FunctionDetails" 273 class="privatelink" onclick="toggle_private();" 274 >hide private</a>]</span></td> 275 </tr> 276 </table> 277 </td> 278</tr> 279</table> 280<a name="with_scopes"></a> 281<div> 282<table class="details" border="1" cellpadding="3" 283 cellspacing="0" width="100%" bgcolor="white"> 284<tr><td> 285 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 286 <tr valign="top"><td> 287 <h3 class="epydoc"><span class="sig"><span class="sig-name">with_scopes</span>(<span class="sig-arg">credentials</span>, 288 <span class="sig-arg">scopes</span>)</span> 289 </h3> 290 </td><td align="right" valign="top" 291 ><span class="codelink"><a href="googleapiclient._auth-pysrc.html#with_scopes">source code</a></span> 292 </td> 293 </tr></table> 294 295 <pre class="literalblock"> 296Scopes the credentials if necessary. 297 298Args: 299 credentials (Union[ 300 google.auth.credentials.Credentials, 301 oauth2client.client.Credentials]): The credentials to scope. 302 scopes (Sequence[str]): The list of scopes. 303 304Returns: 305 Union[google.auth.credentials.Credentials, 306 oauth2client.client.Credentials]: The scoped credentials. 307 308</pre> 309 <dl class="fields"> 310 </dl> 311</td></tr></table> 312</div> 313<a name="authorized_http"></a> 314<div> 315<table class="details" border="1" cellpadding="3" 316 cellspacing="0" width="100%" bgcolor="white"> 317<tr><td> 318 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 319 <tr valign="top"><td> 320 <h3 class="epydoc"><span class="sig"><span class="sig-name">authorized_http</span>(<span class="sig-arg">credentials</span>)</span> 321 </h3> 322 </td><td align="right" valign="top" 323 ><span class="codelink"><a href="googleapiclient._auth-pysrc.html#authorized_http">source code</a></span> 324 </td> 325 </tr></table> 326 327 <pre class="literalblock"> 328Returns an http client that is authorized with the given credentials. 329 330Args: 331 credentials (Union[ 332 google.auth.credentials.Credentials, 333 oauth2client.client.Credentials]): The credentials to use. 334 335Returns: 336 Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]: An 337 authorized http client. 338 339</pre> 340 <dl class="fields"> 341 </dl> 342</td></tr></table> 343</div> 344<br /> 345<!-- ==================== NAVIGATION BAR ==================== --> 346<table class="navbar" border="0" width="100%" cellpadding="0" 347 bgcolor="#a0c0ff" cellspacing="0"> 348 <tr valign="middle"> 349 <!-- Home link --> 350 <th> <a 351 href="googleapiclient-module.html">Home</a> </th> 352 353 <!-- Tree link --> 354 <th> <a 355 href="module-tree.html">Trees</a> </th> 356 357 <!-- Index link --> 358 <th> <a 359 href="identifier-index.html">Indices</a> </th> 360 361 <!-- Help link --> 362 <th> <a 363 href="help.html">Help</a> </th> 364 365 <th class="navbar" width="100%"></th> 366 </tr> 367</table> 368<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 369 <tr> 370 <td align="left" class="footer"> 371 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 372 </td> 373 <td align="right" class="footer"> 374 <a target="mainFrame" href="http://epydoc.sourceforge.net" 375 >http://epydoc.sourceforge.net</a> 376 </td> 377 </tr> 378</table> 379 380<script type="text/javascript"> 381 <!-- 382 // Private objects are initially displayed (because if 383 // javascript is turned off then we want them to be 384 // visible); but by default, we want to hide them. So hide 385 // them unless we have a cookie that says to show them. 386 checkCookie(); 387 // --> 388</script> 389</body> 390</html> 391