4a9cfce722
Conflicts: docs/epy/class-tree.html docs/epy/help.html docs/epy/identifier-index.html docs/epy/module-tree.html docs/epy/oauth2client-module.html docs/epy/oauth2client-pysrc.html docs/epy/oauth2client.anyjson-module.html docs/epy/oauth2client.anyjson-pysrc.html docs/epy/oauth2client.appengine-module.html docs/epy/oauth2client.appengine-pysrc.html docs/epy/oauth2client.appengine.AppAssertionCredentials-class.html docs/epy/oauth2client.appengine.CredentialsModel-class.html docs/epy/oauth2client.appengine.CredentialsNDBModel-class.html docs/epy/oauth2client.appengine.CredentialsNDBProperty-class.html docs/epy/oauth2client.appengine.CredentialsProperty-class.html docs/epy/oauth2client.appengine.FlowNDBProperty-class.html docs/epy/oauth2client.appengine.FlowProperty-class.html docs/epy/oauth2client.appengine.InvalidClientSecretsError-class.html docs/epy/oauth2client.appengine.InvalidXsrfTokenError-class.html docs/epy/oauth2client.appengine.OAuth2Decorator-class.html docs/epy/oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html docs/epy/oauth2client.appengine.SiteXsrfSecretKey-class.html docs/epy/oauth2client.appengine.SiteXsrfSecretKeyNDB-class.html docs/epy/oauth2client.appengine.StorageByKeyName-class.html docs/epy/oauth2client.client-module.html docs/epy/oauth2client.client-pysrc.html docs/epy/oauth2client.client.AccessTokenCredentials-class.html docs/epy/oauth2client.client.AccessTokenCredentialsError-class.html docs/epy/oauth2client.client.AccessTokenRefreshError-class.html docs/epy/oauth2client.client.ApplicationDefaultCredentialsError-class.html docs/epy/oauth2client.client.AssertionCredentials-class.html docs/epy/oauth2client.client.Credentials-class.html docs/epy/oauth2client.client.Error-class.html docs/epy/oauth2client.client.Flow-class.html docs/epy/oauth2client.client.FlowExchangeError-class.html docs/epy/oauth2client.client.GoogleCredentials-class.html docs/epy/oauth2client.client.MemoryCache-class.html docs/epy/oauth2client.client.NonAsciiHeaderError-class.html docs/epy/oauth2client.client.OAuth2Credentials-class.html docs/epy/oauth2client.client.OAuth2WebServerFlow-class.html docs/epy/oauth2client.client.SignedJwtAssertionCredentials-class.html docs/epy/oauth2client.client.Storage-class.html docs/epy/oauth2client.client.TokenRevokeError-class.html docs/epy/oauth2client.client.UnknownClientSecretsFlowError-class.html docs/epy/oauth2client.client.VerifyJwtTokenError-class.html docs/epy/oauth2client.clientsecrets-module.html docs/epy/oauth2client.clientsecrets-pysrc.html docs/epy/oauth2client.clientsecrets.Error-class.html docs/epy/oauth2client.clientsecrets.InvalidClientSecretsError-class.html docs/epy/oauth2client.crypt-module.html docs/epy/oauth2client.crypt-pysrc.html docs/epy/oauth2client.crypt.AppIdentityError-class.html docs/epy/oauth2client.django_orm-module.html docs/epy/oauth2client.django_orm-pysrc.html docs/epy/oauth2client.django_orm.CredentialsField-class.html docs/epy/oauth2client.django_orm.FlowField-class.html docs/epy/oauth2client.django_orm.Storage-class.html docs/epy/oauth2client.file-module.html docs/epy/oauth2client.file-pysrc.html docs/epy/oauth2client.file.CredentialsFileSymbolicLinkError-class.html docs/epy/oauth2client.file.Storage-class.html docs/epy/oauth2client.gce-module.html docs/epy/oauth2client.gce-pysrc.html docs/epy/oauth2client.gce.AppAssertionCredentials-class.html docs/epy/oauth2client.keyring_storage-module.html docs/epy/oauth2client.keyring_storage-pysrc.html docs/epy/oauth2client.keyring_storage.Storage-class.html docs/epy/oauth2client.locked_file-module.html docs/epy/oauth2client.locked_file-pysrc.html docs/epy/oauth2client.locked_file.AlreadyLockedException-class.html docs/epy/oauth2client.locked_file.CredentialsFileSymbolicLinkError-class.html docs/epy/oauth2client.locked_file.LockedFile-class.html docs/epy/oauth2client.locked_file._Opener-class.html docs/epy/oauth2client.locked_file._PosixOpener-class.html docs/epy/oauth2client.multistore_file-module.html docs/epy/oauth2client.multistore_file-pysrc.html docs/epy/oauth2client.multistore_file.Error-class.html docs/epy/oauth2client.multistore_file.NewerCredentialStoreError-class.html docs/epy/oauth2client.multistore_file._MultiStore-class.html docs/epy/oauth2client.multistore_file._MultiStore._Storage-class.html docs/epy/oauth2client.old_run-module.html docs/epy/oauth2client.old_run-pysrc.html docs/epy/oauth2client.service_account-module.html docs/epy/oauth2client.service_account-pysrc.html docs/epy/oauth2client.service_account._ServiceAccountCredentials-class.html docs/epy/oauth2client.tools-module.html docs/epy/oauth2client.tools-pysrc.html docs/epy/oauth2client.tools.ClientRedirectHandler-class.html docs/epy/oauth2client.tools.ClientRedirectServer-class.html docs/epy/oauth2client.util-module.html docs/epy/oauth2client.util-pysrc.html docs/epy/oauth2client.xsrfutil-module.html docs/epy/oauth2client.xsrfutil-pysrc.html docs/epy/redirect.html
509 lines
26 KiB
HTML
509 lines
26 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>oauth2client.client.AssertionCredentials</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="oauth2client-module.html">Package oauth2client</a> ::
|
|
<a href="oauth2client.client-module.html">Module client</a> ::
|
|
Class AssertionCredentials
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="oauth2client.client.AssertionCredentials-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class AssertionCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials">source code</a></span></p>
|
|
<center>
|
|
<center> <map id="uml_class_diagram_for_oauth2cl_19" name="uml_class_diagram_for_oauth2cl_19">
|
|
<area shape="rect" id="node1_19" href="oauth2client.client.AssertionCredentials-class.html#__init__" title="Constructor for AssertionFlowCredentials." alt="" coords="17,535,857,553"/>
|
|
<area shape="rect" id="node1" href="oauth2client.client.AssertionCredentials-class.html" title="Abstract Credentials object used for OAuth 2.0 assertion grants." alt="" coords="5,504,869,560"/>
|
|
<area shape="rect" id="node2_20" href="oauth2client.client.GoogleCredentials-class.html#create_scoped_required" title="Whether this Credentials object is scopeless." alt="" coords="335,385,539,404"/>
|
|
<area shape="rect" id="node2_21" href="oauth2client.client.GoogleCredentials-class.html#create_scoped" title="Create a Credentials object for the given scopes." alt="" coords="335,404,539,423"/>
|
|
<area shape="rect" id="node2_22" href="oauth2client.client.GoogleCredentials-class.html#serialization_data" title="Get the fields and their values identifying the current credentials." alt="" coords="335,423,539,441"/>
|
|
<area shape="rect" id="node2_23" href="oauth2client.client.GoogleCredentials-class.html#get_application_default" title="Get the Application Default Credentials for the current environment." alt="" coords="335,441,539,460"/>
|
|
<area shape="rect" id="node2_24" href="oauth2client.client.GoogleCredentials-class.html#from_stream" title="Create a Credentials object by reading the information from a given file." alt="" coords="335,460,539,479"/>
|
|
<area shape="rect" id="node2" href="oauth2client.client.GoogleCredentials-class.html" title="Application Default Credentials for use in calling Google APIs." alt="" coords="322,355,550,485"/>
|
|
<area shape="rect" id="node3_25" href="oauth2client.client.OAuth2Credentials-class.html#authorize" title="Authorize an httplib2.Http instance with these credentials." alt="" coords="332,124,543,143"/>
|
|
<area shape="rect" id="node3_26" href="oauth2client.client.OAuth2Credentials-class.html#refresh" title="Forces a refresh of the access_token." alt="" coords="332,143,543,161"/>
|
|
<area shape="rect" id="node3_27" href="oauth2client.client.OAuth2Credentials-class.html#revoke" title="Revokes a refresh_token and makes the credentials void." alt="" coords="332,161,543,180"/>
|
|
<area shape="rect" id="node3_28" href="oauth2client.client.OAuth2Credentials-class.html#apply" title="Add the authorization to the headers." alt="" coords="332,180,543,199"/>
|
|
<area shape="rect" id="node3_29" href="oauth2client.client.OAuth2Credentials-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="332,199,543,217"/>
|
|
<area shape="rect" id="node3_30" href="oauth2client.client.OAuth2Credentials-class.html#from_json" title="Instantiate a Credentials object from a JSON description of it." alt="" coords="332,217,543,236"/>
|
|
<area shape="rect" id="node3_31" href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired" title="True if the credential is expired or invalid." alt="" coords="332,236,543,255"/>
|
|
<area shape="rect" id="node3_32" href="oauth2client.client.OAuth2Credentials-class.html#get_access_token" title="Return the access token and its expiration information." alt="" coords="332,255,543,273"/>
|
|
<area shape="rect" id="node3_33" href="oauth2client.client.OAuth2Credentials-class.html#set_store" title="Set the Storage for the credential." alt="" coords="332,273,543,292"/>
|
|
<area shape="rect" id="node3_34" href="oauth2client.client.OAuth2Credentials-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="332,292,543,311"/>
|
|
<area shape="rect" id="node3_35" href="oauth2client.client.OAuth2Credentials-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="332,311,543,329"/>
|
|
<area shape="rect" id="node3" href="oauth2client.client.OAuth2Credentials-class.html" title="Credentials object for OAuth 2.0." alt="" coords="320,93,555,336"/>
|
|
<area shape="rect" id="node4_36" href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS" title="oauth2client.client.Credentials.NON_SERIALIZED_MEMBERS" alt="" coords="340,28,535,47"/>
|
|
<area shape="rect" id="node4_37" 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="340,49,535,68"/>
|
|
<area shape="rect" id="node4" href="oauth2client.client.Credentials-class.html" title="Base class for all Credentials objects." alt="" coords="328,5,547,75"/>
|
|
</map>
|
|
<img src="uml_class_diagram_for_oauth2cl_19.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_19" ismap="ismap" class="graph-without-title" />
|
|
</center>
|
|
</center>
|
|
<hr />
|
|
<pre class="literalblock">
|
|
Abstract Credentials object used for OAuth 2.0 assertion grants.
|
|
|
|
This credential does not require a flow to instantiate because it
|
|
represents a two legged flow, and therefore has all of the required
|
|
information to generate and refresh its own access tokens. It must
|
|
be subclassed to generate the appropriate assertion string.
|
|
|
|
AssertionCredentials objects may be safely pickled and unpickled.
|
|
|
|
</pre>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Instance Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-InstanceMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">assertion_type</span>,
|
|
<span class="summary-sig-arg">user_agent</span>=<span class="summary-sig-default">None</span>,
|
|
<span class="summary-sig-arg">token_uri</span>=<span class="summary-sig-default">GOOGLE_TOKEN_URI</span>,
|
|
<span class="summary-sig-arg">revoke_uri</span>=<span class="summary-sig-default">GOOGLE_REVOKE_URI</span>,
|
|
<span class="summary-sig-arg">**unused_kwargs</span>)</span><br />
|
|
Constructor for AssertionFlowCredentials.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body" class="summary-sig-name" onclick="show_private();">_generate_refresh_request_body</a>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Generate the body that will be used in the refresh request.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a name="_generate_assertion"></a><span class="summary-sig-name">_generate_assertion</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
Generate the assertion string that will be used in the access token
|
|
request.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_assertion">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.client.AssertionCredentials-class.html#_revoke" class="summary-sig-name" onclick="show_private();">_revoke</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">http_request</span>)</span><br />
|
|
Revokes the access_token and deletes the store if available.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.GoogleCredentials-class.html">GoogleCredentials</a></code></b>:
|
|
<code><a href="oauth2client.client.GoogleCredentials-class.html#create_scoped">create_scoped</a></code>,
|
|
<code><a href="oauth2client.client.GoogleCredentials-class.html#create_scoped_required">create_scoped_required</a></code>,
|
|
<code><a href="oauth2client.client.GoogleCredentials-class.html#serialization_data">serialization_data</a></code>
|
|
</p>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#get_access_token">get_access_token</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
|
|
</p>
|
|
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b> (private):
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_expires_in" onclick="show_private();">_expires_in</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">_refresh</a></code>,
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
|
|
</p></div>
|
|
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b> (private):
|
|
<code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
|
|
</p></div>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__delattr__</code>,
|
|
<code>__format__</code>,
|
|
<code>__getattribute__</code>,
|
|
<code>__hash__</code>,
|
|
<code>__new__</code>,
|
|
<code>__reduce__</code>,
|
|
<code>__reduce_ex__</code>,
|
|
<code>__repr__</code>,
|
|
<code>__setattr__</code>,
|
|
<code>__sizeof__</code>,
|
|
<code>__str__</code>,
|
|
<code>__subclasshook__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS METHODS ==================== -->
|
|
<a name="section-ClassMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Class Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-ClassMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">OAuth2Credentials</a></code></b>:
|
|
<code><a href="oauth2client.client.OAuth2Credentials-class.html#from_json">from_json</a></code>
|
|
</p>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
|
|
<code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== STATIC METHODS ==================== -->
|
|
<a name="section-StaticMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Static Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-StaticMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.GoogleCredentials-class.html">GoogleCredentials</a></code></b>:
|
|
<code><a href="oauth2client.client.GoogleCredentials-class.html#from_stream">from_stream</a></code>,
|
|
<code><a href="oauth2client.client.GoogleCredentials-class.html#get_application_default">get_application_default</a></code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS VARIABLES ==================== -->
|
|
<a name="section-ClassVariables"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Class Variables</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-ClassVariables"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">Credentials</a></code></b>:
|
|
<code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<a name="section-Properties"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Properties</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-Properties"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__class__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Method Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-MethodDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="__init__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">assertion_type</span>,
|
|
<span class="sig-arg">user_agent</span>=<span class="sig-default">None</span>,
|
|
<span class="sig-arg">token_uri</span>=<span class="sig-default">GOOGLE_TOKEN_URI</span>,
|
|
<span class="sig-arg">revoke_uri</span>=<span class="sig-default">GOOGLE_REVOKE_URI</span>,
|
|
<span class="sig-arg">**unused_kwargs</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials.__init__">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Constructor for AssertionFlowCredentials.
|
|
|
|
Args:
|
|
assertion_type: string, assertion type that will be declared to the auth
|
|
server
|
|
user_agent: string, The HTTP User-Agent to provide for this application.
|
|
token_uri: string, URI for token endpoint. For convenience
|
|
defaults to Google's endpoints but any OAuth 2.0 provider can be used.
|
|
revoke_uri: string, URI for revoke endpoint.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Decorators:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><code>@util.positional(2)</code></li>
|
|
</ul></dd>
|
|
<dt>Overrides:
|
|
object.__init__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_generate_refresh_request_body"></a>
|
|
<div class="private">
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">_generate_refresh_request_body</span>(<span class="sig-arg">self</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._generate_refresh_request_body">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Generate the body that will be used in the refresh request.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
<a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_body" onclick="show_private();">OAuth2Credentials._generate_refresh_request_body</a>
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="_revoke"></a>
|
|
<div class="private">
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">_revoke</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">http_request</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.client-pysrc.html#AssertionCredentials._revoke">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Revokes the access_token and deletes the store if available.
|
|
|
|
Args:
|
|
http_request: callable, a callable that matches the method signature of
|
|
httplib2.Http.request, used to make the revoke request.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
<a href="oauth2client.client.OAuth2Credentials-class.html#_revoke" onclick="show_private();">OAuth2Credentials._revoke</a>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Thu Aug 14 12:00:38 2014
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|