Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1408f44a2a36b0993217a1db9c4c267dbb7e59a6 / . / docs / epy / oauth2client.clientsecrets-module.html
blob: e5b46967dd4e38fceea9ae8b9881bba3db799069 [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.clientsecrets</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 Module&nbsp;clientsecrets
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&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.clientsecrets-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module clientsecrets</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.clientsecrets-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Utilities for reading OAuth 2.0 client secret files.
58
59A client_secrets.json file contains all the information needed to interact with
60an OAuth 2.0 protected service.
61
62</pre>
63
64<hr />
65<div class="fields"> <p><strong>Author:</strong>
66 jcgregorio@google.com (Joe Gregorio)
67 </p>
68</div><!-- ==================== CLASSES ==================== -->
69<a name="section-Classes"></a>
70<table class="summary" border="1" cellpadding="3"
71 cellspacing="0" width="100%" bgcolor="white">
72<tr bgcolor="#70b0f0" class="table-header">
73 <td colspan="2" class="table-header">
74 <table border="0" cellpadding="0" cellspacing="0" width="100%">
75 <tr valign="top">
76 <td align="left"><span class="table-header">Classes</span></td>
77 <td align="right" valign="top"
78 ><span class="options">[<a href="#section-Classes"
79 class="privatelink" onclick="toggle_private();"
80 >hide private</a>]</span></td>
81 </tr>
82 </table>
83 </td>
84</tr>
85<tr>
86 <td width="15%" align="right" valign="top" class="summary">
87 <span class="summary-type">&nbsp;</span>
88 </td><td class="summary">
89 <a href="oauth2client.clientsecrets.Error-class.html" class="summary-name">Error</a><br />
90 Base error for this module.
91 </td>
92 </tr>
93<tr>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type">&nbsp;</span>
96 </td><td class="summary">
97 <a href="oauth2client.clientsecrets.InvalidClientSecretsError-class.html" class="summary-name">InvalidClientSecretsError</a><br />
98 Format of ClientSecrets file is invalid.
99 </td>
100 </tr>
101</table>
102<!-- ==================== FUNCTIONS ==================== -->
103<a name="section-Functions"></a>
104<table class="summary" border="1" cellpadding="3"
105 cellspacing="0" width="100%" bgcolor="white">
106<tr bgcolor="#70b0f0" class="table-header">
107 <td colspan="2" class="table-header">
108 <table border="0" cellpadding="0" cellspacing="0" width="100%">
109 <tr valign="top">
110 <td align="left"><span class="table-header">Functions</span></td>
111 <td align="right" valign="top"
112 ><span class="options">[<a href="#section-Functions"
113 class="privatelink" onclick="toggle_private();"
114 >hide private</a>]</span></td>
115 </tr>
116 </table>
117 </td>
118</tr>
119<tr class="private">
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <td><span class="summary-sig"><a name="_validate_clientsecrets"></a><span class="summary-sig-name">_validate_clientsecrets</span>(<span class="summary-sig-arg">obj</span>)</span></td>
126 <td align="right" valign="top">
127 <span class="codelink"><a href="oauth2client.clientsecrets-pysrc.html#_validate_clientsecrets">source&nbsp;code</a></span>
128
129 </td>
130 </tr>
131 </table>
132
133 </td>
134 </tr>
135<tr>
136 <td width="15%" align="right" valign="top" class="summary">
137 <span class="summary-type">&nbsp;</span>
138 </td><td class="summary">
139 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td><span class="summary-sig"><a name="load"></a><span class="summary-sig-name">load</span>(<span class="summary-sig-arg">fp</span>)</span></td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="oauth2client.clientsecrets-pysrc.html#load">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a name="loads"></a><span class="summary-sig-name">loads</span>(<span class="summary-sig-arg">s</span>)</span></td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="oauth2client.clientsecrets-pysrc.html#loads">source&nbsp;code</a></span>
160
161 </td>
162 </tr>
163 </table>
164
165 </td>
166 </tr>
167<tr>
168 <td width="15%" align="right" valign="top" class="summary">
169 <span class="summary-type">&nbsp;</span>
170 </td><td class="summary">
171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td><span class="summary-sig"><a name="loadfile"></a><span class="summary-sig-name">loadfile</span>(<span class="summary-sig-arg">filename</span>)</span></td>
174 <td align="right" valign="top">
175 <span class="codelink"><a href="oauth2client.clientsecrets-pysrc.html#loadfile">source&nbsp;code</a></span>
176
177 </td>
178 </tr>
179 </table>
180
181 </td>
182 </tr>
183</table>
184<!-- ==================== VARIABLES ==================== -->
185<a name="section-Variables"></a>
186<table class="summary" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr bgcolor="#70b0f0" class="table-header">
189 <td colspan="2" class="table-header">
190 <table border="0" cellpadding="0" cellspacing="0" width="100%">
191 <tr valign="top">
192 <td align="left"><span class="table-header">Variables</span></td>
193 <td align="right" valign="top"
194 ><span class="options">[<a href="#section-Variables"
195 class="privatelink" onclick="toggle_private();"
196 >hide private</a>]</span></td>
197 </tr>
198 </table>
199 </td>
200</tr>
201<tr>
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <a name="TYPE_WEB"></a><span class="summary-name">TYPE_WEB</span> = <code title="'web'"><code class="variable-quote">'</code><code class="variable-string">web</code><code class="variable-quote">'</code></code>
206 </td>
207 </tr>
208<tr>
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <a name="TYPE_INSTALLED"></a><span class="summary-name">TYPE_INSTALLED</span> = <code title="'installed'"><code class="variable-quote">'</code><code class="variable-string">installed</code><code class="variable-quote">'</code></code>
213 </td>
214 </tr>
215<tr>
216 <td width="15%" align="right" valign="top" class="summary">
217 <span class="summary-type">&nbsp;</span>
218 </td><td class="summary">
219 <a href="oauth2client.clientsecrets-module.html#VALID_CLIENT" class="summary-name">VALID_CLIENT</a> = <code title="{'installed': {'required': ['client_id',
220 'client_secret',
221 'redirect_uris',
222 'auth_uri',
223 'token_uri'],
224 'string': ['client_id', 'client_secret']},
225 'web': {'required': ['client_id',
226 'client_secret',
227..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">installed</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">required</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">client_id</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">clien</code><code class="variable-ellipsis">...</code></code>
228 </td>
229 </tr>
230<tr>
231 <td width="15%" align="right" valign="top" class="summary">
232 <span class="summary-type">&nbsp;</span>
233 </td><td class="summary">
234 <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>
235 </td>
236 </tr>
237</table>
238<!-- ==================== VARIABLES DETAILS ==================== -->
239<a name="section-VariablesDetails"></a>
240<table class="details" border="1" cellpadding="3"
241 cellspacing="0" width="100%" bgcolor="white">
242<tr bgcolor="#70b0f0" class="table-header">
243 <td colspan="2" class="table-header">
244 <table border="0" cellpadding="0" cellspacing="0" width="100%">
245 <tr valign="top">
246 <td align="left"><span class="table-header">Variables Details</span></td>
247 <td align="right" valign="top"
248 ><span class="options">[<a href="#section-VariablesDetails"
249 class="privatelink" onclick="toggle_private();"
250 >hide private</a>]</span></td>
251 </tr>
252 </table>
253 </td>
254</tr>
255</table>
256<a name="VALID_CLIENT"></a>
257<div>
258<table class="details" border="1" cellpadding="3"
259 cellspacing="0" width="100%" bgcolor="white">
260<tr><td>
261 <h3 class="epydoc">VALID_CLIENT</h3>
262
263 <dl class="fields">
264 </dl>
265 <dl class="fields">
266 <dt>Value:</dt>
267 <dd><table><tr><td><pre class="variable">
268<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">installed</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">required</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">client_id</code><code class="variable-quote">'</code><code class="variable-op">,</code>
269 <code class="variable-quote">'</code><code class="variable-string">client_secret</code><code class="variable-quote">'</code><code class="variable-op">,</code>
270 <code class="variable-quote">'</code><code class="variable-string">redirect_uris</code><code class="variable-quote">'</code><code class="variable-op">,</code>
271 <code class="variable-quote">'</code><code class="variable-string">auth_uri</code><code class="variable-quote">'</code><code class="variable-op">,</code>
272 <code class="variable-quote">'</code><code class="variable-string">token_uri</code><code class="variable-quote">'</code><code class="variable-group">]</code><code class="variable-op">,</code>
273 <code class="variable-quote">'</code><code class="variable-string">string</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">client_id</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">client_secret</code><code class="variable-quote">'</code><code class="variable-group">]</code><code class="variable-group">}</code><code class="variable-op">,</code>
274 <code class="variable-quote">'</code><code class="variable-string">web</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">required</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">client_id</code><code class="variable-quote">'</code><code class="variable-op">,</code>
275 <code class="variable-quote">'</code><code class="variable-string">client_secret</code><code class="variable-quote">'</code><code class="variable-op">,</code>
276<code class="variable-ellipsis">...</code>
277</pre></td></tr></table>
278</dd>
279 </dl>
280</td></tr></table>
281</div>
282<br />
283<!-- ==================== NAVIGATION BAR ==================== -->
284<table class="navbar" border="0" width="100%" cellpadding="0"
285 bgcolor="#a0c0ff" cellspacing="0">
286 <tr valign="middle">
287
288 <!-- Tree link -->
289 <th>&nbsp;&nbsp;&nbsp;<a
290 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
291
292 <!-- Index link -->
293 <th>&nbsp;&nbsp;&nbsp;<a
294 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
295
296 <!-- Help link -->
297 <th>&nbsp;&nbsp;&nbsp;<a
298 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
299
300 <th class="navbar" width="100%"></th>
301 </tr>
302</table>
303<table border="0" cellpadding="0" cellspacing="0" width="100%%">
304 <tr>
305 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]306 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:08 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]307 </td>
308 <td align="right" class="footer">
309 <a target="mainFrame" href="http://epydoc.sourceforge.net"
310 >http://epydoc.sourceforge.net</a>
311 </td>
312 </tr>
313</table>
314
315<script type="text/javascript">
316 <!--
317 // Private objects are initially displayed (because if
318 // javascript is turned off then we want them to be
319 // visible); but by default, we want to hide them. So hide
320 // them unless we have a cookie that says to show them.
321 checkCookie();
322 // -->
323</script>
324</body>
325</html>