Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / identitytoolkit_v3.relyingparty.html
blob: b5325ea20ad21c4c1783160f4d9bb7001d5e34ca [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="identitytoolkit_v3.html">Google Identity Toolkit API</a> . <a href="identitytoolkit_v3.relyingparty.html">relyingparty</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#createAuthUri">createAuthUri(body)</a></code></p>
79<p class="firstline">Creates the URI used by the IdP to authenticate the user.</p>
80<p class="toc_element">
81 <code><a href="#deleteAccount">deleteAccount(body)</a></code></p>
82<p class="firstline">Delete user account.</p>
83<p class="toc_element">
84 <code><a href="#downloadAccount">downloadAccount(body)</a></code></p>
85<p class="firstline">Batch download user accounts.</p>
86<p class="toc_element">
87 <code><a href="#getAccountInfo">getAccountInfo(body)</a></code></p>
88<p class="firstline">Returns the account info.</p>
89<p class="toc_element">
90 <code><a href="#getOobConfirmationCode">getOobConfirmationCode(body)</a></code></p>
91<p class="firstline">Get a code for user action confirmation.</p>
92<p class="toc_element">
93 <code><a href="#getPublicKeys">getPublicKeys()</a></code></p>
94<p class="firstline">Get token signing public key.</p>
95<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]96 <code><a href="#getRecaptchaParam">getRecaptchaParam()</a></code></p>
97<p class="firstline">Get recaptcha secure param.</p>
98<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99 <code><a href="#resetPassword">resetPassword(body)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]100<p class="firstline">Reset password for a user.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<p class="toc_element">
102 <code><a href="#setAccountInfo">setAccountInfo(body)</a></code></p>
103<p class="firstline">Set account info for a user.</p>
104<p class="toc_element">
105 <code><a href="#uploadAccount">uploadAccount(body)</a></code></p>
106<p class="firstline">Batch upload existing user accounts.</p>
107<p class="toc_element">
108 <code><a href="#verifyAssertion">verifyAssertion(body)</a></code></p>
109<p class="firstline">Verifies the assertion returned by the IdP.</p>
110<p class="toc_element">
111 <code><a href="#verifyPassword">verifyPassword(body)</a></code></p>
112<p class="firstline">Verifies the user entered password.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="createAuthUri">createAuthUri(body)</code>
116 <pre>Creates the URI used by the IdP to authenticate the user.
117
118Args:
119 body: object, The request body. (required)
120 The object takes the form of:
121
122{ # Request to get the IDP authentication URL.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]123 "openidRealm": "A String", # Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
124 "oauthScope": "A String", # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 "clientId": "A String", # The relying party OAuth client ID.
126 "otaApp": "A String", # The native app package for OTA installation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]127 "oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
129 "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
130 "appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
131 "continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]132 "identifier": "A String", # The email or federated ID of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 }
134
135
136Returns:
137 An object of the form:
138
139 { # Response of creating the IDP authentication URL.
140 "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]141 "captchaRequired": True or False, # True if captcha is required.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 "registered": True or False, # Whether the user is registered if the identifier is an email.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]143 "forExistingProvider": True or False, # True if the authUri is for user's existing provider.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]144 "providerId": "A String", # The provider ID of the auth URI.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 "authUri": "A String", # The URI used by the IDP to authenticate the user.
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="deleteAccount">deleteAccount(body)</code>
151 <pre>Delete user account.
152
153Args:
154 body: object, The request body. (required)
155 The object takes the form of:
156
157{ # Request to delete account.
158 "localId": "A String", # The local ID of the user.
159 }
160
161
162Returns:
163 An object of the form:
164
165 { # Respone of deleting account.
166 "kind": "identitytoolkit#DeleteAccountResponse", # The fixed string "identitytoolkit#DeleteAccountResponse".
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="downloadAccount">downloadAccount(body)</code>
172 <pre>Batch download user accounts.
173
174Args:
175 body: object, The request body. (required)
176 The object takes the form of:
177
178{ # Request to download user account in batch.
179 "nextPageToken": "A String", # The token for the next page. This should be taken from the previous response.
180 "maxResults": 42, # The max number of results to return in the response.
181 }
182
183
184Returns:
185 An object of the form:
186
187 { # Respone of downloading accounts in batch.
188 "nextPageToken": "A String", # The next page token. To be used in a subsequent request to return the next page of results.
189 "kind": "identitytoolkit#DownloadAccountResponse", # The fixed string "identitytoolkit#DownloadAccountResponse".
190 "users": [ # The user accounts data.
191 { # Template for an individual account info.
192 "displayName": "A String", # The name of the user.
193 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 "photoUrl": "A String", # The URL of the user profile photo.
196 "emailVerified": True or False, # Whether the email has been verified.
197 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]198 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 "version": 42, # Version of the user's password.
200 "providerUserInfo": [ # The IDP of the user.
201 {
202 "federatedId": "A String", # User's identifier at IDP.
203 "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
204 "displayName": "A String", # The user's display name at the IDP.
205 "photoUrl": "A String", # The user's photo url at the IDP.
206 },
207 ],
208 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
209 "salt": "A String", # The user's password salt.
210 "email": "A String", # The email of the user.
211 },
212 ],
213 }</pre>
214</div>
215
216<div class="method">
217 <code class="details" id="getAccountInfo">getAccountInfo(body)</code>
218 <pre>Returns the account info.
219
220Args:
221 body: object, The request body. (required)
222 The object takes the form of:
223
224{ # Request to get the account information.
225 "idToken": "A String", # The GITKit token of the authenticated user.
226 "email": [ # The list of emails of the users to inquiry.
227 "A String",
228 ],
229 "localId": [ # The list of local ID's of the users to inquiry.
230 "A String",
231 ],
232 }
233
234
235Returns:
236 An object of the form:
237
238 { # Response of getting account information.
239 "kind": "identitytoolkit#GetAccountInfoResponse", # The fixed string "identitytoolkit#GetAccountInfoResponse".
240 "users": [ # The info of the users.
241 { # Template for an individual account info.
242 "displayName": "A String", # The name of the user.
243 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]244 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 "photoUrl": "A String", # The URL of the user profile photo.
246 "emailVerified": True or False, # Whether the email has been verified.
247 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]248 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 "version": 42, # Version of the user's password.
250 "providerUserInfo": [ # The IDP of the user.
251 {
252 "federatedId": "A String", # User's identifier at IDP.
253 "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
254 "displayName": "A String", # The user's display name at the IDP.
255 "photoUrl": "A String", # The user's photo url at the IDP.
256 },
257 ],
258 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
259 "salt": "A String", # The user's password salt.
260 "email": "A String", # The email of the user.
261 },
262 ],
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="getOobConfirmationCode">getOobConfirmationCode(body)</code>
268 <pre>Get a code for user action confirmation.
269
270Args:
271 body: object, The request body. (required)
272 The object takes the form of:
273
274{ # Request of getting a code for user confirmation (reset password, change email etc.)
275 "kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".
276 "requestType": "A String", # The request type.
277 "idToken": "A String", # The user's Gitkit login token for email change.
278 "challenge": "A String", # The recaptcha challenge presented to the user.
279 "newEmail": "A String", # The new email if the code is for email change.
280 "userIp": "A String", # The IP address of the user.
281 "email": "A String", # The email of the user.
282 "captchaResp": "A String", # The recaptcha response from the user.
283 }
284
285
286Returns:
287 An object of the form:
288
289 { # Response of getting a code for user confirmation (reset password, change email etc.).
290 "kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".
291 "oobCode": "A String", # The code to be send to the user.
292 }</pre>
293</div>
294
295<div class="method">
296 <code class="details" id="getPublicKeys">getPublicKeys()</code>
297 <pre>Get token signing public key.
298
299Args:
300
301Returns:
302 An object of the form:
303
304 { # Respone of getting public keys.
305 "a_key": "A String",
306 }</pre>
307</div>
308
309<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]310 <code class="details" id="getRecaptchaParam">getRecaptchaParam()</code>
311 <pre>Get recaptcha secure param.
312
313Args:
314
315Returns:
316 An object of the form:
317
318 { # Response of getting recaptcha param.
319 "kind": "identitytoolkit#GetRecaptchaParamResponse", # The fixed string "identitytoolkit#GetRecaptchaParamResponse".
320 "recaptchaSiteKey": "A String", # Site key registered at recaptcha.
321 "recaptchaStoken": "A String", # The stoken field for the recaptcha widget, used to request captcha challenge.
322 }</pre>
323</div>
324
325<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 <code class="details" id="resetPassword">resetPassword(body)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]327 <pre>Reset password for a user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328
329Args:
330 body: object, The request body. (required)
331 The object takes the form of:
332
333{ # Request to reset the password.
334 "newPassword": "A String", # The new password inputted by the user.
335 "oldPassword": "A String", # The old password inputted by the user.
336 "oobCode": "A String", # The confirmation code.
337 "email": "A String", # The email address of the user.
338 }
339
340
341Returns:
342 An object of the form:
343
344 { # Response of resetting the password.
345 "kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
346 "email": "A String", # The user's email.
347 }</pre>
348</div>
349
350<div class="method">
351 <code class="details" id="setAccountInfo">setAccountInfo(body)</code>
352 <pre>Set account info for a user.
353
354Args:
355 body: object, The request body. (required)
356 The object takes the form of:
357
358{ # Request to set the account information.
359 "displayName": "A String", # The name of the user.
360 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]361 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]362 "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
363 "captchaResponse": "A String", # Response to the captcha.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]364 "emailVerified": True or False, # Mark the email as verified or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]365 "provider": [ # The associated IDPs of the user.
366 "A String",
367 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]368 "disableUser": True or False, # Whether to disable the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]369 "captchaChallenge": "A String", # The captcha challenge.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]370 "idToken": "A String", # The GITKit token of the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 "oobCode": "A String", # The out-of-band code of the change email request.
372 "password": "A String", # The new password of the user.
373 "email": "A String", # The email of the user.
374 }
375
376
377Returns:
378 An object of the form:
379
380 { # Respone of setting the account information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
382 "displayName": "A String", # The name of the user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]383 "newEmail": "A String", # The new email the user attempts to change to.
384 "idToken": "A String", # The Gitkit id token to login the newly sign up user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]385 "providerUserInfo": [ # The user's profiles at the associated IdPs.
386 {
387 "providerId": "A String", # The IdP ID. For whitelisted IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
388 "displayName": "A String", # The user's display name at the IDP.
389 "photoUrl": "A String", # The user's photo url at the IDP.
390 },
391 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]392 "email": "A String", # The email of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393 }</pre>
394</div>
395
396<div class="method">
397 <code class="details" id="uploadAccount">uploadAccount(body)</code>
398 <pre>Batch upload existing user accounts.
399
400Args:
401 body: object, The request body. (required)
402 The object takes the form of:
403
404{ # Request to upload user account in batch.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]405 "hashAlgorithm": "A String", # The password hash algorithm.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 "users": [ # The account info to be stored.
407 { # Template for an individual account info.
408 "displayName": "A String", # The name of the user.
409 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]410 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]411 "photoUrl": "A String", # The URL of the user profile photo.
412 "emailVerified": True or False, # Whether the email has been verified.
413 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]414 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]415 "version": 42, # Version of the user's password.
416 "providerUserInfo": [ # The IDP of the user.
417 {
418 "federatedId": "A String", # User's identifier at IDP.
419 "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
420 "displayName": "A String", # The user's display name at the IDP.
421 "photoUrl": "A String", # The user's photo url at the IDP.
422 },
423 ],
424 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
425 "salt": "A String", # The user's password salt.
426 "email": "A String", # The email of the user.
427 },
428 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]429 "signerKey": "A String", # The key for to hash the password.
430 "memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
431 "saltSeparator": "A String", # The salt separator.
432 "rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]433 }
434
435
436Returns:
437 An object of the form:
438
439 { # Respone of uploading accounts in batch.
440 "kind": "identitytoolkit#UploadAccountResponse", # The fixed string "identitytoolkit#UploadAccountResponse".
441 "error": [ # The error encountered while processing the account info.
442 {
443 "index": 42, # The index of the malformed account, starting from 0.
444 "message": "A String", # Detailed error message for the account info.
445 },
446 ],
447 }</pre>
448</div>
449
450<div class="method">
451 <code class="details" id="verifyAssertion">verifyAssertion(body)</code>
452 <pre>Verifies the assertion returned by the IdP.
453
454Args:
455 body: object, The request body. (required)
456 The object takes the form of:
457
458{ # Request to verify the IDP assertion.
459 "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
460 "postBody": "A String", # The post body if the request is a HTTP POST.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]461 "returnRefreshToken": True or False, # Whether to return refresh tokens.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]462 "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
463 }
464
465
466Returns:
467 An object of the form:
468
469 { # Response of verifying the IDP assertion.
470 "federatedId": "A String", # The unique ID identifies the IdP account.
471 "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
472 "photoUrl": "A String", # The URI of the public accessible profiel picture.
473 "inputEmail": "A String", # It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email.
474 "appScheme": "A String", # The custom scheme used by mobile app.
475 "verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
476 "A String",
477 ],
478 "providerId": "A String", # The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned.
479 "dateOfBirth": "A String", # The birth date of the IdP account.
480 "nickName": "A String", # The nick name of the user.
481 "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]482 "oauthAccessToken": "A String", # The OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]483 "language": "A String", # The language preference of the user.
484 "needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
485 "fullName": "A String", # The full name of the user.
486 "kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".
487 "idToken": "A String", # The ID token.
488 "displayName": "A String", # The display name of the user.
489 "appInstallationUrl": "A String", # URL for OTA app installation.
490 "firstName": "A String", # The first name of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]491 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 "emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
493 "oauthScope": "A String", # The scope for the OpenID OAuth extension.
494 "oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]495 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]496 "originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.
497 "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
498 "lastName": "A String", # The last name of the user.
499 "action": "A String", # The action code.
500 "timeZone": "A String", # The timezone of the user.
501 "emailRecycled": True or False, # It's true if the email is recycled.
502 }</pre>
503</div>
504
505<div class="method">
506 <code class="details" id="verifyPassword">verifyPassword(body)</code>
507 <pre>Verifies the user entered password.
508
509Args:
510 body: object, The request body. (required)
511 The object takes the form of:
512
513{ # Request to verify the password.
514 "captchaResponse": "A String", # Response to the captcha.
515 "captchaChallenge": "A String", # The captcha challenge.
516 "password": "A String", # The password inputed by the user.
517 "email": "A String", # The email of the user.
518 "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
519 }
520
521
522Returns:
523 An object of the form:
524
525 { # Request of verifying the password.
526 "kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".
527 "displayName": "A String", # The name of the user.
528 "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]529 "oauthAccessToken": "A String", # The OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]530 "photoUrl": "A String", # The URI of the user's photo at IdP
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]531 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 "idToken": "A String", # The GITKit token for authenticated user.
533 "registered": True or False, # Whether the email is registered.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]534 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]535 "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
536 }</pre>
537</div>
538
539</body></html>