Blame - docs/oauth2client.client.html - platform/external/python/google-api-python-client

2011-09-15 09:53:21 -0400

[diff] [blame]

12

<tt>An OAuth 2.0 client.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

13

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

14

Tools for interacting with OAuth 2.0 protected resources.</tt>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

<big>Modules</big></td></tr>

20

21

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

22

23

<a href="oauth2client.clientsecrets.html">oauth2client.clientsecrets</a>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

24

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

25

</td><td width="25%" valign=top><a href="datetime.html">datetime</a>

26

<a href="httplib2.html">httplib2</a>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

27

<a href="logging.html">logging</a>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

28

</td><td width="25%" valign=top><a href="os.html">os</a>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

29

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

30

31

</td><td width="25%" valign=top><a href="time.html">time</a>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

32

<a href="urllib.html">urllib</a>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

33

<a href="urlparse.html">urlparse</a>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

34

</td></tr></table></td></tr></table>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

<big>Classes</big></td></tr>

<dt><a href="__builtin__.html#object">__builtin__.object</a>

43

</dt><dd>

44

<dl>

45

<dt><a href="oauth2client.client.html#Credentials">Credentials</a>

46

</dt><dd>

47

<dl>

48

<dt><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

49

</dt><dd>

50

<dl>

51

<dt><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

52

</dt><dt><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

53

</dt><dd>

54

<dl>

55

<dt><a href="oauth2client.client.html#SignedJwtAssertionCredentials">SignedJwtAssertionCredentials</a>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

56

</dt></dl>

57

</dd>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

58

</dl>

59

</dd>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

60

</dl>

61

</dd>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

</dt><dd>

<dl>

<dt><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a>

66

</dt></dl>

67

</dd>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

68

<dt><a href="oauth2client.client.html#MemoryCache">MemoryCache</a>

69

</dt><dt><a href="oauth2client.client.html#Storage">Storage</a>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

70

</dt></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

71

</dd>

72

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

73

</dt><dd>

74

<dl>

75

<dt><a href="oauth2client.client.html#Error">Error</a>

76

</dt><dd>

77

<dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

78

<dt><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

79

</dt><dt><a href="oauth2client.client.html#AccessTokenRefreshError">AccessTokenRefreshError</a>

80

</dt><dt><a href="oauth2client.client.html#FlowExchangeError">FlowExchangeError</a>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

81

</dt><dt><a href="oauth2client.client.html#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

82

</dt><dt><a href="oauth2client.client.html#VerifyJwtTokenError">VerifyJwtTokenError</a>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

</dt></dl>

</dd>

</dl>

</dd>

</dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

92

<a name="AccessTokenCredentials">class AccessTokenCredentials</a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</td></tr>

93

94

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

95

<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 2.0.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

96

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

97

<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the

98

<a href="#AccessTokenCredentials-authorize">authorize</a>() method, which then signs each request from that <a href="__builtin__.html#object">object</a>

99

with the OAuth 2.0 access token.  This set of credentials is for the

100

use case where you have acquired an OAuth 2.0 access_token from

101

another place such as a JavaScript client or another web

102

application, and wish to use it from Python. Because only the

103

access_token is present it can not be refreshed and will in time

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

104

expire.

105

Joe Gregorio

fffa7d7

2011-02-18 17:20:39 -0500

[diff] [blame]

106

<a href="#AccessTokenCredentials">AccessTokenCredentials</a> objects may be safely pickled and unpickled.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

107

108

Usage:

109

credentials = <a href="#AccessTokenCredentials">AccessTokenCredentials</a>('<an access token>',

110

'my-user-agent/1.0')

111

http = httplib2.Http()

112

http = credentials.<a href="#AccessTokenCredentials-authorize">authorize</a>(http)

113

114

Exceptions:

115

AccessTokenCredentialsExpired: raised when the access_token expires or is

116

revoked.  </tt></td></tr>

117

118

<td width="100%"><dl><dt>Method resolution order:</dt>

119

<dd><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a></dd>

120

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

121

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

122

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

123

</dl>

124

<hr>

125

Methods defined here:

126

<dl><dt><a name="AccessTokenCredentials-__init__">__init__</a>(self, access_token, user_agent)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>

127

128

This is one of the few types if <a href="#Credentials">Credentials</a> that you should contrust,

129

<a href="#Credentials">Credentials</a> objects are usually instantiated by a <a href="#Flow">Flow</a>.

130

131

Args:

Joe Gregorio

9384170

2011-03-02 16:12:05 -0800

[diff] [blame]

132

access_token: string, access token.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

133

user_agent: string, The HTTP User-Agent to provide for this application.

134

135

Notes:

136

store: callable, a callable that when passed a Credential

137

will store the credential back to where it came from.</tt></dd></dl>

138

139

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

140

Class methods defined here:

141

<dl><dt><a name="AccessTokenCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt></dl>

142

143

<hr>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

144

Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

145

<dl><dt><a name="AccessTokenCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

146

147

<dl><dt><a name="AccessTokenCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

148

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

149

<dl><dt><a name="AccessTokenCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

150

151

Args:

152

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

153

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

154

<dl><dt><a name="AccessTokenCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

155

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

156

The modified http.request method will add authentication headers to each

157

request and will refresh access_tokens when a 401 is received on a

158

request. In addition the http.request method has a credentials property,

159

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

160

it.

161

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

162

Args:

163

http: An instance of httplib2.Http

164

or something that acts like it.

165

166

Returns:

167

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#AccessTokenCredentials-authorize">authorize</a>(h)

173

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

174

You can't create a new OAuth subclass of httplib2.Authenication

175

because it never gets passed the absolute URI, which is needed for

176

signing. So instead we have to overload 'request' with a closure

177

that adds in the Authorization header and then calls the original

178

version of 'request()'.</tt></dd></dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

179

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

180

<dl><dt><a name="AccessTokenCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

181

182

Args:

183

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

184

request.</tt></dd></dl>

185

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

186

<dl><dt><a name="AccessTokenCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

187

188

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

189

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

190

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

191

has expired and been refreshed.  This implementation uses

192

locking to check for updates before updating the

193

access_token.</tt></dd></dl>

194

195

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

196

197

<hr>

Joe Gregorio

2011-02-17 15:32:11 -0500

[diff] [blame]

198

Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

199

<dl><dt>access_token_expired</dt>

200

<dd><tt>True if the credential is expired or invalid.

201

202

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

2011-02-17 15:32:11 -0500

[diff] [blame]

203

</dl>

204

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

205

Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

206

<dl><dt><a name="AccessTokenCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

207

representation produced by <a href="#AccessTokenCredentials-to_json">to_json</a>().

208

209

Args:

210

s: string, JSON from <a href="#AccessTokenCredentials-to_json">to_json</a>().

211

212

Returns:

213

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

214

215

216

<hr>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

217

Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

218

219

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

220

</dl>

221

<dl><dt>__weakref__</dt>

222

<dd><tt>list of weak references to the object (if defined)</tt></dd>

223

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

224

<hr>

225

Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

226

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

227

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

</td></tr></table>

<a name="AccessTokenCredentialsError">class AccessTokenCredentialsError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

233

234

235

<td colspan=2><tt>Having only the access_token means no refresh is possible.  </tt></td></tr>

236

237

<td width="100%"><dl><dt>Method resolution order:</dt>

238

<dd><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a></dd>

239

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

240

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

241

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

242

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

243

</dl>

244

<hr>

245

Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:

246

<dl><dt>__weakref__</dt>

247

<dd><tt>list of weak references to the object (if defined)</tt></dd>

248

</dl>

249

<hr>

250

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

251

<dl><dt><a name="AccessTokenCredentialsError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

252

253

<hr>

254

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

255

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#AccessTokenCredentialsError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

256

257

<hr>

258

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

259

<dl><dt><a name="AccessTokenCredentialsError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

260

261

<dl><dt><a name="AccessTokenCredentialsError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

262

263

<dl><dt><a name="AccessTokenCredentialsError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

264

265

<dl><dt><a name="AccessTokenCredentialsError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

266

267

Use of negative indices is not supported.</tt></dd></dl>

268

269

<dl><dt><a name="AccessTokenCredentialsError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="AccessTokenCredentialsError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

274

275

<dl><dt><a name="AccessTokenCredentialsError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="AccessTokenCredentialsError-__unicode__">__unicode__</a>(...)</dt></dl>

280

281

<hr>

282

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

293

<a name="AccessTokenRefreshError">class AccessTokenRefreshError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

294

295

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame]

296

<td colspan=2><tt><a href="#Error">Error</a> trying to refresh an expired access token.  </tt></td></tr>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

297

298

<td width="100%"><dl><dt>Method resolution order:</dt>

299

<dd><a href="oauth2client.client.html#AccessTokenRefreshError">AccessTokenRefreshError</a></dd>

300

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

301

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

302

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

303

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

304

</dl>

305

<hr>

306

Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:

307

<dl><dt>__weakref__</dt>

308

<dd><tt>list of weak references to the object (if defined)</tt></dd>

309

</dl>

310

<hr>

311

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

312

<dl><dt><a name="AccessTokenRefreshError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

313

314

<hr>

315

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

316

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#AccessTokenRefreshError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

317

318

<hr>

319

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

320

<dl><dt><a name="AccessTokenRefreshError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

321

322

<dl><dt><a name="AccessTokenRefreshError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

323

324

<dl><dt><a name="AccessTokenRefreshError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

325

326

<dl><dt><a name="AccessTokenRefreshError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

327

328

Use of negative indices is not supported.</tt></dd></dl>

329

330

<dl><dt><a name="AccessTokenRefreshError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="AccessTokenRefreshError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

335

336

<dl><dt><a name="AccessTokenRefreshError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="AccessTokenRefreshError-__unicode__">__unicode__</a>(...)</dt></dl>

341

342

<hr>

343

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

354

<a name="AssertionCredentials">class AssertionCredentials</a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</td></tr>

355

356

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

357

<td colspan=2><tt>Abstract <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> used for OAuth 2.0 assertion grants.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

358

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

359

This credential does not require a flow to instantiate because it

360

represents a two legged flow, and therefore has all of the required

361

information to generate and refresh its own access tokens.  It must

362

be subclassed to generate the appropriate assertion string.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

363

364

<a href="#AssertionCredentials">AssertionCredentials</a> objects may be safely pickled and unpickled.  </tt></td></tr>

365

366

<td width="100%"><dl><dt>Method resolution order:</dt>

367

<dd><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a></dd>

368

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

369

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

370

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

371

</dl>

372

<hr>

373

Methods defined here:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

374

<dl><dt><a name="AssertionCredentials-__init__">__init__</a>(self, assertion_type, user_agent, token_uri='https://accounts.google.com/o/oauth2/token', **unused_kwargs)</dt><dd><tt>Constructor for AssertionFlowCredentials.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

375

376

Args:

377

assertion_type: string, assertion type that will be declared to the auth

378

server

379

user_agent: string, The HTTP User-Agent to provide for this application.

380

token_uri: string, URI for token endpoint. For convenience

381

defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt></dd></dl>

382

383

<hr>

384

Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

385

<dl><dt><a name="AssertionCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

386

387

<dl><dt><a name="AssertionCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

388

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

389

<dl><dt><a name="AssertionCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

390

391

Args:

392

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

393

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

394

<dl><dt><a name="AssertionCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

395

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

396

The modified http.request method will add authentication headers to each

397

request and will refresh access_tokens when a 401 is received on a

398

request. In addition the http.request method has a credentials property,

399

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

400

it.

401

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

402

Args:

403

http: An instance of httplib2.Http

404

or something that acts like it.

405

406

Returns:

407

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#AssertionCredentials-authorize">authorize</a>(h)

413

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

414

You can't create a new OAuth subclass of httplib2.Authenication

415

because it never gets passed the absolute URI, which is needed for

416

signing. So instead we have to overload 'request' with a closure

417

that adds in the Authorization header and then calls the original

418

version of 'request()'.</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

419

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

420

<dl><dt><a name="AssertionCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

421

422

Args:

423

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

424

request.</tt></dd></dl>

425

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

426

<dl><dt><a name="AssertionCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

427

428

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

429

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

430

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

431

has expired and been refreshed.  This implementation uses

432

locking to check for updates before updating the

433

access_token.</tt></dd></dl>

<hr>

Class methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

439

<dl><dt><a name="AssertionCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON

440

should have been produced by calling .<a href="#AssertionCredentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.

441

442

Args:

443

data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.

444

445

Returns:

446

An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

447

448

<hr>

449

Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

450

<dl><dt>access_token_expired</dt>

451

<dd><tt>True if the credential is expired or invalid.

452

453

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

454

</dl>

455

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

456

Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

457

<dl><dt><a name="AssertionCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

458

representation produced by <a href="#AssertionCredentials-to_json">to_json</a>().

459

460

Args:

461

s: string, JSON from <a href="#AssertionCredentials-to_json">to_json</a>().

462

463

Returns:

464

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

465

466

467

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

468

Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

469

470

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

471

</dl>

472

<dl><dt>__weakref__</dt>

473

<dd><tt>list of weak references to the object (if defined)</tt></dd>

474

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

475

<hr>

476

Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

477

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

478

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

</td></tr></table>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

483

<a name="Credentials">class Credentials</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

484

485

486

<td colspan=2><tt>Base class for all <a href="#Credentials">Credentials</a> objects.

487

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

488

Subclasses must define an <a href="#Credentials-authorize">authorize</a>() method that applies the credentials to

489

an HTTP transport.

490

491

Subclasses must also specify a classmethod named 'from_json' that takes a JSON

Joe Gregorio

d02bf5e

2012-03-02 13:21:32 -0800

[diff] [blame]

492

string as input and returns an instaniated <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a>.  </tt></td></tr>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

493

494

<td width="100%">Methods defined here:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

495

<dl><dt><a name="Credentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

496

497

Args:

498

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

499

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

500

<dl><dt><a name="Credentials-authorize">authorize</a>(self, http)</dt><dd><tt>Take an httplib2.Http instance (or equivalent) and

501

authorizes it for the set of credentials, usually by

502

replacing http.request() with a method that adds in

503

the appropriate headers and then delegates to the original

504

Http.request() method.</tt></dd></dl>

505

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

506

<dl><dt><a name="Credentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

507

508

Args:

509

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

510

request.</tt></dd></dl>

511

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

512

<dl><dt><a name="Credentials-to_json">to_json</a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="#Credentials">Credentials</a>.

513

514

Returns:

515

string, a JSON representation of this instance, suitable to pass to

Joe Gregorio

6121dd9

2012-04-13 07:50:04 -0400

[diff] [blame]

516

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

517

518

<hr>

519

Class methods defined here:

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame]

520

<dl><dt><a name="Credentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it.

521

522

The JSON should have been produced by calling .<a href="#Credentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.

Joe Gregorio

6121dd9

2012-04-13 07:50:04 -0400

[diff] [blame]

523

524

Args:

525

data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.

526

527

Returns:

528

An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>

529

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

530

<dl><dt><a name="Credentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

531

representation produced by <a href="#Credentials-to_json">to_json</a>().

532

533

Args:

534

s: string, JSON from <a href="#Credentials-to_json">to_json</a>().

535

536

Returns:

537

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

538

539

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

540

<hr>

541

Data descriptors defined here:

542

543

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

544

</dl>

545

<dl><dt>__weakref__</dt>

546

<dd><tt>list of weak references to the object (if defined)</tt></dd>

547

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

548

<hr>

549

Data and other attributes defined here:

550

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

551

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

</td></tr></table>

<a name="Error">class Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

557

558

559

<td colspan=2><tt>Base error for this module.  </tt></td></tr>

560

561

<td width="100%"><dl><dt>Method resolution order:</dt>

562

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

563

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

564

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

565

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

566

</dl>

567

<hr>

568

Data descriptors defined here:

569

<dl><dt>__weakref__</dt>

570

<dd><tt>list of weak references to the object (if defined)</tt></dd>

571

</dl>

572

<hr>

573

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

574

<dl><dt><a name="Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

575

576

<hr>

577

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

578

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

579

580

<hr>

581

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

582

<dl><dt><a name="Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

583

584

<dl><dt><a name="Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

585

586

<dl><dt><a name="Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

587

588

<dl><dt><a name="Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

589

590

Use of negative indices is not supported.</tt></dd></dl>

591

592

<dl><dt><a name="Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

597

598

<dl><dt><a name="Error-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="Error-__unicode__">__unicode__</a>(...)</dt></dl>

603

604

<hr>

605

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

<a name="Flow">class Flow</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

617

618

619

<td colspan=2><tt>Base class for all <a href="#Flow">Flow</a> objects.  </tt></td></tr>

620

621

<td width="100%">Data descriptors defined here:

622

623

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

624

</dl>

625

<dl><dt>__weakref__</dt>

626

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

632

<a name="FlowExchangeError">class FlowExchangeError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

633

634

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame]

635

<td colspan=2><tt><a href="#Error">Error</a> trying to exchange an authorization grant for an access token.  </tt></td></tr>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

636

637

<td width="100%"><dl><dt>Method resolution order:</dt>

638

<dd><a href="oauth2client.client.html#FlowExchangeError">FlowExchangeError</a></dd>

639

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

640

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

641

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

642

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

643

</dl>

644

<hr>

645

Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:

646

<dl><dt>__weakref__</dt>

647

<dd><tt>list of weak references to the object (if defined)</tt></dd>

648

</dl>

649

<hr>

650

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

651

<dl><dt><a name="FlowExchangeError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

652

653

<hr>

654

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

655

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#FlowExchangeError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

656

657

<hr>

658

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

659

<dl><dt><a name="FlowExchangeError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

660

661

<dl><dt><a name="FlowExchangeError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

662

663

<dl><dt><a name="FlowExchangeError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

664

665

<dl><dt><a name="FlowExchangeError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

666

667

Use of negative indices is not supported.</tt></dd></dl>

668

669

<dl><dt><a name="FlowExchangeError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="FlowExchangeError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

674

675

<dl><dt><a name="FlowExchangeError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="FlowExchangeError-__unicode__">__unicode__</a>(...)</dt></dl>

680

681

<hr>

682

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

</td></tr></table>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

693

<a name="MemoryCache">class MemoryCache</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

694

695

696

<td colspan=2><tt>httplib2 Cache implementation which only caches locally.  </tt></td></tr>

697

698

<td width="100%">Methods defined here:

699

700

701

<dl><dt><a name="MemoryCache-delete">delete</a>(self, key)</dt></dl>

<dl><dt><a name="MemoryCache-set">set</a>(self, key, value)</dt></dl>

706

707

<hr>

708

Data descriptors defined here:

709

710

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

711

</dl>

712

<dl><dt>__weakref__</dt>

713

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

719

<a name="OAuth2Credentials">class OAuth2Credentials</a>(<a href="oauth2client.client.html#Credentials">Credentials</a>)</td></tr>

720

721

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

722

<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 2.0.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

723

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

724

<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the <a href="#OAuth2Credentials-authorize">authorize</a>()

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

725

method, which then adds the OAuth 2.0 access token to each request.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

726

727

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.  </tt></td></tr>

728

729

<td width="100%"><dl><dt>Method resolution order:</dt>

730

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

731

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

732

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

733

</dl>

734

<hr>

735

Methods defined here:

736

<dl><dt><a name="OAuth2Credentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

737

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

738

<dl><dt><a name="OAuth2Credentials-__init__">__init__</a>(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent, id_token=None)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

739

740

This constructor is not usually called by the user, instead

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

741

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects are instantiated by the <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

742

743

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

744

access_token: string, access token.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

745

client_id: string, client identifier.

746

client_secret: string, client secret.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

747

refresh_token: string, refresh token.

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

748

token_expiry: datetime, when the access_token expires.

749

token_uri: string, URI of token endpoint.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

750

user_agent: string, The HTTP User-Agent to provide for this application.

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

751

id_token: <a href="__builtin__.html#object">object</a>, The identity of the resource owner.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

752

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

753

Notes:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

754

store: callable, A callable that when passed a Credential

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

755

will store the credential back to where it came from.

756

This is needed to store the latest access_token if it

757

has expired and been refreshed.</tt></dd></dl>

758

759

<dl><dt><a name="OAuth2Credentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

760

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

761

<dl><dt><a name="OAuth2Credentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

762

763

Args:

764

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

765

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

766

<dl><dt><a name="OAuth2Credentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

767

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

768

The modified http.request method will add authentication headers to each

769

request and will refresh access_tokens when a 401 is received on a

770

request. In addition the http.request method has a credentials property,

771

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

772

it.

773

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

774

Args:

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

775

http: An instance of httplib2.Http

776

or something that acts like it.

777

778

Returns:

779

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#OAuth2Credentials-authorize">authorize</a>(h)

785

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

786

You can't create a new OAuth subclass of httplib2.Authenication

787

because it never gets passed the absolute URI, which is needed for

788

signing. So instead we have to overload 'request' with a closure

789

that adds in the Authorization header and then calls the original

790

version of 'request()'.</tt></dd></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

791

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

792

<dl><dt><a name="OAuth2Credentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

793

794

Args:

795

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

796

request.</tt></dd></dl>

797

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

798

<dl><dt><a name="OAuth2Credentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

799

800

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

801

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

802

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

803

has expired and been refreshed.  This implementation uses

804

locking to check for updates before updating the

805

access_token.</tt></dd></dl>

<hr>

Class methods defined here:

811

<dl><dt><a name="OAuth2Credentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON

812

should have been produced by calling .<a href="#OAuth2Credentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.

813

814

Args:

815

data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.

816

817

Returns:

818

An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

819

820

<hr>

Joe Gregorio

2011-02-17 15:32:11 -0500

[diff] [blame]

821

Data descriptors defined here:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

822

<dl><dt>access_token_expired</dt>

823

<dd><tt>True if the credential is expired or invalid.

824

825

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

2011-02-17 15:32:11 -0500

[diff] [blame]

826

</dl>

827

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

828

Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

829

<dl><dt><a name="OAuth2Credentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

830

representation produced by <a href="#OAuth2Credentials-to_json">to_json</a>().

831

832

Args:

833

s: string, JSON from <a href="#OAuth2Credentials-to_json">to_json</a>().

834

835

Returns:

836

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

837

838

839

<hr>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

840

Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

841

842

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

843

</dl>

844

<dl><dt>__weakref__</dt>

845

<dd><tt>list of weak references to the object (if defined)</tt></dd>

846

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

847

<hr>

848

Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

849

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

850

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

</td></tr></table>

<a name="OAuth2WebServerFlow">class OAuth2WebServerFlow</a>(<a href="oauth2client.client.html#Flow">Flow</a>)</td></tr>

856

857

858

<td colspan=2><tt>Does the Web Server <a href="#Flow">Flow</a> for OAuth 2.0.

859

860

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.  </tt></td></tr>

861

862

<td width="100%"><dl><dt>Method resolution order:</dt>

863

<dd><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a></dd>

864

865

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

866

</dl>

867

<hr>

868

Methods defined here:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

869

<dl><dt><a name="OAuth2WebServerFlow-__init__">__init__</a>(self, client_id, client_secret, scope, user_agent=None, auth_uri='https://accounts.google.com/o/oauth2/auth', token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)</dt><dd><tt>Constructor for <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

870

871

Args:

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

872

client_id: string, client identifier.

873

client_secret: string client secret.

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

874

scope: string or list of strings, scope(s) of the credentials being

875

requested.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

876

user_agent: string, HTTP User-Agent to provide for this application.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

877

auth_uri: string, URI for authorization endpoint. For convenience

878

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

879

token_uri: string, URI for token endpoint. For convenience

880

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

881

**kwargs: dict, The keyword arguments are all optional and required

882

parameters for the OAuth calls.</tt></dd></dl>

883

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

884

<dl><dt><a name="OAuth2WebServerFlow-step1_get_authorize_url">step1_get_authorize_url</a>(self, redirect_uri='urn:ietf:wg:oauth:2.0:oob')</dt><dd><tt>Returns a URI to redirect to the provider.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

885

886

Args:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

887

redirect_uri: string, Either the string 'urn:ietf:wg:oauth:2.0:oob' for

888

a non-web-based application, or a URI that handles the callback from

889

the authorization server.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

890

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

891

If redirect_uri is 'urn:ietf:wg:oauth:2.0:oob' then pass in the

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

892

generated verification code to step2_exchange,

893

otherwise pass in the query parameters received

894

at the callback uri to step2_exchange.</tt></dd></dl>

895

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

896

<dl><dt><a name="OAuth2WebServerFlow-step2_exchange">step2_exchange</a>(self, code, http=None)</dt><dd><tt>Exhanges a code for <a href="#OAuth2Credentials">OAuth2Credentials</a>.

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

897

898

Args:

899

code: string or dict, either the code as a string, or a dictionary

900

of the query parameters to the redirect_uri, which contains

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

901

the code.

Joe Gregorio

746096f

2012-06-15 10:53:36 -0400

[diff] [blame]

902

http: httplib2.Http, optional http instance to use to do the fetch

903

904

Returns:

905

An <a href="#OAuth2Credentials">OAuth2Credentials</a> <a href="__builtin__.html#object">object</a> that can be used to authorize requests.

906

907

Raises:

908

<a href="#FlowExchangeError">FlowExchangeError</a> if a problem occured exchanging the code for a

909

refresh_token.</tt></dd></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

910

911

<hr>

912

Data descriptors inherited from <a href="oauth2client.client.html#Flow">Flow</a>:

913

914

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

915

</dl>

916

<dl><dt>__weakref__</dt>

917

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

</td></tr></table>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

923

<a name="SignedJwtAssertionCredentials">class SignedJwtAssertionCredentials</a>(<a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a>)</td></tr>

924

925

926

<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> used for OAuth 2.0 Signed JWT assertion grants.

927

928

This credential does not require a flow to instantiate because it

929

represents a two legged flow, and therefore has all of the required

930

information to generate and refresh its own access tokens.  </tt></td></tr>

931

932

<td width="100%"><dl><dt>Method resolution order:</dt>

933

<dd><a href="oauth2client.client.html#SignedJwtAssertionCredentials">SignedJwtAssertionCredentials</a></dd>

934

<dd><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a></dd>

935

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

936

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

937

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

938

</dl>

939

<hr>

940

Methods defined here:

941

<dl><dt><a name="SignedJwtAssertionCredentials-__init__">__init__</a>(self, service_account_name, private_key, scope, private_key_password='notasecret', user_agent=None, token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)</dt><dd><tt>Constructor for <a href="#SignedJwtAssertionCredentials">SignedJwtAssertionCredentials</a>.

942

943

Args:

944

service_account_name: string, id for account, usually an email address.

945

private_key: string, private key in P12 format.

946

scope: string or list of strings, scope(s) of the credentials being

947

requested.

948

private_key_password: string, password for private_key.

949

user_agent: string, HTTP User-Agent to provide for this application.

950

token_uri: string, URI for token endpoint. For convenience

951

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

952

kwargs: kwargs, Additional parameters to add to the JWT token, for

953

example prn=joe@xample.org.</tt></dd></dl>

954

955

<hr>

956

Class methods defined here:

957

<dl><dt><a name="SignedJwtAssertionCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt></dl>

958

959

<hr>

960

Data and other attributes defined here:

961

<dl><dt>MAX_TOKEN_LIFETIME_SECS = 3600</dl>

962

963

<hr>

964

Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

965

<dl><dt><a name="SignedJwtAssertionCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

966

967

<dl><dt><a name="SignedJwtAssertionCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

968

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

969

<dl><dt><a name="SignedJwtAssertionCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

970

971

Args:

972

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

973

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

974

<dl><dt><a name="SignedJwtAssertionCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

975

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

976

The modified http.request method will add authentication headers to each

977

request and will refresh access_tokens when a 401 is received on a

978

request. In addition the http.request method has a credentials property,

979

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

980

it.

981

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

982

Args:

983

http: An instance of httplib2.Http

984

or something that acts like it.

985

986

Returns:

987

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#SignedJwtAssertionCredentials-authorize">authorize</a>(h)

993

994

You can't create a new OAuth subclass of httplib2.Authenication

995

because it never gets passed the absolute URI, which is needed for

996

signing. So instead we have to overload 'request' with a closure

997

that adds in the Authorization header and then calls the original

998

version of 'request()'.</tt></dd></dl>

999

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

1000

<dl><dt><a name="SignedJwtAssertionCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

1001

1002

Args:

1003

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

1004

request.</tt></dd></dl>

1005

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

1006

<dl><dt><a name="SignedJwtAssertionCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.

1007

1008

Args:

1009

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

1010

This is needed to store the latest access_token if it

1011

has expired and been refreshed.  This implementation uses

1012

locking to check for updates before updating the

1013

access_token.</tt></dd></dl>

<hr>

Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

1019

<dl><dt>access_token_expired</dt>

1020

<dd><tt>True if the credential is expired or invalid.

1021

1022

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

1023

</dl>

1024

<hr>

1025

Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

1026

<dl><dt><a name="SignedJwtAssertionCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

1027

representation produced by <a href="#SignedJwtAssertionCredentials-to_json">to_json</a>().

1028

1029

Args:

1030

s: string, JSON from <a href="#SignedJwtAssertionCredentials-to_json">to_json</a>().

1031

1032

Returns:

1033

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

<hr>

Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

1038

1039

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

1040

</dl>

1041

<dl><dt>__weakref__</dt>

1042

<dd><tt>list of weak references to the object (if defined)</tt></dd>

1043

</dl>

1044

<hr>

1045

Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:

1046

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

</td></tr></table>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1052

<a name="Storage">class Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

1053

1054

1055

<td colspan=2><tt>Base class for all <a href="#Storage">Storage</a> objects.

1056

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

1057

Store and retrieve a single credential.  This class supports locking

1058

such that multiple processes and threads can operate on a single

1059

store.  </tt></td></tr>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1060

1061

<td width="100%">Methods defined here:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

1062

<dl><dt><a name="Storage-acquire_lock">acquire_lock</a>(self)</dt><dd><tt>Acquires any lock necessary to access this <a href="#Storage">Storage</a>.

1063

1064

This lock is not reentrant.</tt></dd></dl>

1065

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

1066

<dl><dt><a name="Storage-delete">delete</a>(self)</dt><dd><tt>Delete credential.

1067

1068

Frees any resources associated with storing the credential.

1069

The <a href="#Storage">Storage</a> lock must *not* be held when this is called.

Returns:

None</tt></dd></dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1074

<dl><dt><a name="Storage-get">get</a>(self)</dt><dd><tt>Retrieve credential.

1075

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

1076

The <a href="#Storage">Storage</a> lock must *not* be held when this is called.

1077

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1078

Returns:

Joe Gregorio

20a5aa9

2011-04-01 17:44:25 -0400

[diff] [blame]

1079

oauth2client.client.<a href="#Credentials">Credentials</a></tt></dd></dl>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1080

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

1081

<dl><dt><a name="Storage-locked_delete">locked_delete</a>(self)</dt><dd><tt>Delete a credential.

1082

1083

The <a href="#Storage">Storage</a> lock must be held when this is called.</tt></dd></dl>

1084

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

1085

<dl><dt><a name="Storage-locked_get">locked_get</a>(self)</dt><dd><tt>Retrieve credential.

1086

1087

The <a href="#Storage">Storage</a> lock must be held when this is called.

1088

1089

Returns:

1090

oauth2client.client.<a href="#Credentials">Credentials</a></tt></dd></dl>

1091

1092

<dl><dt><a name="Storage-locked_put">locked_put</a>(self, credentials)</dt><dd><tt>Write a credential.

1093

1094

The <a href="#Storage">Storage</a> lock must be held when this is called.

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1095

1096

Args:

1097

credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>

1098

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

1099

<dl><dt><a name="Storage-put">put</a>(self, credentials)</dt><dd><tt>Write a credential.

1100

1101

The <a href="#Storage">Storage</a> lock must be held when this is called.

1102

1103

Args:

1104

credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>

1105

1106

<dl><dt><a name="Storage-release_lock">release_lock</a>(self)</dt><dd><tt>Release the <a href="#Storage">Storage</a> lock.

1107

1108

Trying to release a lock that isn't held will result in a

1109

RuntimeError.</tt></dd></dl>

1110

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

1111

<hr>

1112

Data descriptors defined here:

1113

1114

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

1115

</dl>

1116

<dl><dt>__weakref__</dt>

1117

<dd><tt>list of weak references to the object (if defined)</tt></dd>

1118

</dl>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

</td></tr></table>

<a name="UnknownClientSecretsFlowError">class UnknownClientSecretsFlowError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

1124

1125

1126

<td colspan=2><tt>The client secrets file called for an unknown type of OAuth 2.0 flow.  </tt></td></tr>

1127

1128

<td width="100%"><dl><dt>Method resolution order:</dt>

1129

<dd><a href="oauth2client.client.html#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a></dd>

1130

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

1131

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

1132

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

1133

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

1134

</dl>

1135

<hr>

1136

Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:

1137

<dl><dt>__weakref__</dt>

1138

<dd><tt>list of weak references to the object (if defined)</tt></dd>

1139

</dl>

1140

<hr>

1141

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

1142

<dl><dt><a name="UnknownClientSecretsFlowError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

1143

1144

<hr>

1145

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

1146

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#UnknownClientSecretsFlowError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

1147

1148

<hr>

1149

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

1150

<dl><dt><a name="UnknownClientSecretsFlowError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

1151

1152

<dl><dt><a name="UnknownClientSecretsFlowError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

1153

1154

<dl><dt><a name="UnknownClientSecretsFlowError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

1155

1156

<dl><dt><a name="UnknownClientSecretsFlowError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

1157

1158

Use of negative indices is not supported.</tt></dd></dl>

1159

1160

<dl><dt><a name="UnknownClientSecretsFlowError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="UnknownClientSecretsFlowError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

1165

1166

<dl><dt><a name="UnknownClientSecretsFlowError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="UnknownClientSecretsFlowError-__unicode__">__unicode__</a>(...)</dt></dl>

1171

1172

<hr>

1173

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

</td></tr></table>

<a name="VerifyJwtTokenError">class VerifyJwtTokenError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

1185

1186

1187

<td colspan=2><tt>Could on retrieve certificates for validation.  </tt></td></tr>

1188

1189

<td width="100%"><dl><dt>Method resolution order:</dt>

1190

<dd><a href="oauth2client.client.html#VerifyJwtTokenError">VerifyJwtTokenError</a></dd>

1191

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

1192

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

1193

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

1194

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

1195

</dl>

1196

<hr>

1197

Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:

1198

<dl><dt>__weakref__</dt>

1199

<dd><tt>list of weak references to the object (if defined)</tt></dd>

1200

</dl>

1201

<hr>

1202

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

1203

<dl><dt><a name="VerifyJwtTokenError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

1204

1205

<hr>

1206

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

1207

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#VerifyJwtTokenError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

1208

1209

<hr>

1210

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

1211

<dl><dt><a name="VerifyJwtTokenError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

1212

1213

<dl><dt><a name="VerifyJwtTokenError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

1214

1215

<dl><dt><a name="VerifyJwtTokenError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

1216

1217

<dl><dt><a name="VerifyJwtTokenError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

1218

1219

Use of negative indices is not supported.</tt></dd></dl>

1220

1221

<dl><dt><a name="VerifyJwtTokenError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="VerifyJwtTokenError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#VerifyJwtTokenError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

1226

1227

<dl><dt><a name="VerifyJwtTokenError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="VerifyJwtTokenError-__unicode__">__unicode__</a>(...)</dt></dl>

1232

1233

<hr>

1234

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

1241

</td></tr></table></td></tr></table>

1242

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

1243

1244

1245

<big>Functions</big></td></tr>

1246

1247

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame]

1248

<td width="100%"><dl><dt><a name="-credentials_from_clientsecrets_and_code">credentials_from_clientsecrets_and_code</a>(filename, scope, code, message=None, redirect_uri='postmessage', http=None)</dt><dd><tt>Returns <a href="#OAuth2Credentials">OAuth2Credentials</a> from a clientsecrets file and an auth code.

1249

1250

Will create the right kind of <a href="#Flow">Flow</a> based on the contents of the clientsecrets

1251

file or will raise InvalidClientSecretsError for unknown types of Flows.

1252

1253

Args:

1254

filename: string, File name of clientsecrets.

1255

scope: string or list of strings, scope(s) to request.

1256

code: string, An authroization code, most likely passed down from

1257

the client

1258

message: string, A friendly string to display to the user if the

1259

clientsecrets file is missing or invalid. If message is provided then

1260

sys.exit will be called in the case of an error. If message in not

1261

provided then clientsecrets.InvalidClientSecretsError will be raised.

1262

redirect_uri: string, this is generally set to 'postmessage' to match the

1263

redirect_uri that the client specified

1264

http: httplib2.Http, optional http instance to use to do the fetch

1265

1266

Returns:

1267

An <a href="#OAuth2Credentials">OAuth2Credentials</a> <a href="__builtin__.html#object">object</a>.

1268

1269

Raises:

1270

<a href="#FlowExchangeError">FlowExchangeError</a> if the authorization code cannot be exchanged for an

1271

access token

1272

<a href="#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a> if the file describes an unknown kind of <a href="#Flow">Flow</a>.

1273

clientsecrets.InvalidClientSecretsError if the clientsecrets file is

1274

invalid.</tt></dd></dl>

1275

<dl><dt><a name="-credentials_from_code">credentials_from_code</a>(client_id, client_secret, scope, code, redirect_uri='postmessage', http=None, user_agent=None, token_uri='https://accounts.google.com/o/oauth2/token')</dt><dd><tt>Exchanges an authorization code for an <a href="#OAuth2Credentials">OAuth2Credentials</a> <a href="__builtin__.html#object">object</a>.

1276

1277

Args:

1278

client_id: string, client identifier.

1279

client_secret: string, client secret.

1280

scope: string or list of strings, scope(s) to request.

1281

code: string, An authroization code, most likely passed down from

1282

the client

1283

redirect_uri: string, this is generally set to 'postmessage' to match the

1284

redirect_uri that the client specified

1285

http: httplib2.Http, optional http instance to use to do the fetch

1286

token_uri: string, URI for token endpoint. For convenience

1287

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

1288

Returns:

1289

An <a href="#OAuth2Credentials">OAuth2Credentials</a> <a href="__builtin__.html#object">object</a>.

1290

1291

Raises:

1292

<a href="#FlowExchangeError">FlowExchangeError</a> if the authorization code cannot be exchanged for an

1293

access token</tt></dd></dl>

1294

<dl><dt><a name="-flow_from_clientsecrets">flow_from_clientsecrets</a>(filename, scope, message=None)</dt><dd><tt>Create a <a href="#Flow">Flow</a> from a clientsecrets file.

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame]

1295

1296

Will create the right kind of <a href="#Flow">Flow</a> based on the contents of the clientsecrets

1297

file or will raise InvalidClientSecretsError for unknown types of Flows.

1298

1299

Args:

1300

filename: string, File name of client secrets.

1301

scope: string or list of strings, scope(s) to request.

1302

message: string, A friendly string to display to the user if the

1303

clientsecrets file is missing or invalid. If message is provided then

1304

sys.exit will be called in the case of an error. If message in not

1305

provided then clientsecrets.InvalidClientSecretsError will be raised.

1306

1307

Returns:

1308

A <a href="#Flow">Flow</a> <a href="__builtin__.html#object">object</a>.

1309

1310

Raises:

1311

<a href="#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a> if the file describes an unknown kind of <a href="#Flow">Flow</a>.

1312

clientsecrets.InvalidClientSecretsError if the clientsecrets file is

1313

invalid.</tt></dd></dl>

Joe Gregorio