Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 70d03943e3a36983866fe40947aef79a16892ec3 / . / docs / dyn / identitytoolkit_v3.relyingparty.html
blob: eb3f8614ba692f5fe1c4a21953e84a1bea49db96 [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">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]93 <code><a href="#getProjectConfig">getProjectConfig()</a></code></p>
94<p class="firstline">Get project configuration.</p>
95<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96 <code><a href="#getPublicKeys">getPublicKeys()</a></code></p>
97<p class="firstline">Get token signing public key.</p>
98<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]99 <code><a href="#getRecaptchaParam">getRecaptchaParam()</a></code></p>
100<p class="firstline">Get recaptcha secure param.</p>
101<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 <code><a href="#resetPassword">resetPassword(body)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]103<p class="firstline">Reset password for a user.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104<p class="toc_element">
105 <code><a href="#setAccountInfo">setAccountInfo(body)</a></code></p>
106<p class="firstline">Set account info for a user.</p>
107<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 <code><a href="#signOutUser">signOutUser(body)</a></code></p>
109<p class="firstline">Sign out user.</p>
110<p class="toc_element">
111 <code><a href="#signupNewUser">signupNewUser(body)</a></code></p>
112<p class="firstline">Signup new user.</p>
113<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 <code><a href="#uploadAccount">uploadAccount(body)</a></code></p>
115<p class="firstline">Batch upload existing user accounts.</p>
116<p class="toc_element">
117 <code><a href="#verifyAssertion">verifyAssertion(body)</a></code></p>
118<p class="firstline">Verifies the assertion returned by the IdP.</p>
119<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]120 <code><a href="#verifyCustomToken">verifyCustomToken(body)</a></code></p>
121<p class="firstline">Verifies the developer asserted ID token.</p>
122<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 <code><a href="#verifyPassword">verifyPassword(body)</a></code></p>
124<p class="firstline">Verifies the user entered password.</p>
125<h3>Method Details</h3>
126<div class="method">
127 <code class="details" id="createAuthUri">createAuthUri(body)</code>
128 <pre>Creates the URI used by the IdP to authenticate the user.
129
130Args:
131 body: object, The request body. (required)
132 The object takes the form of:
133
134{ # Request to get the IDP authentication URL.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]135 "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.
136 "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]137 "clientId": "A String", # The relying party OAuth client ID.
138 "otaApp": "A String", # The native app package for OTA installation.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]139 "oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 "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.
141 "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
142 "appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
143 "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]144 "identifier": "A String", # The email or federated ID of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]145 }
146
147
148Returns:
149 An object of the form:
150
151 { # Response of creating the IDP authentication URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]152 "sessionId": "A String", # Session ID which should be passed in the following verifyAssertion request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]154 "captchaRequired": True or False, # True if captcha is required.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 "registered": True or False, # Whether the user is registered if the identifier is an email.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156 "allProviders": [ # all providers the user has once used to do federated login
157 "A String",
158 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]159 "forExistingProvider": True or False, # True if the authUri is for user's existing provider.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]160 "providerId": "A String", # The provider ID of the auth URI.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 "authUri": "A String", # The URI used by the IDP to authenticate the user.
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="deleteAccount">deleteAccount(body)</code>
167 <pre>Delete user account.
168
169Args:
170 body: object, The request body. (required)
171 The object takes the form of:
172
173{ # Request to delete account.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 "localId": "A String", # The local ID of the user.
176 }
177
178
179Returns:
180 An object of the form:
181
182 { # Respone of deleting account.
183 "kind": "identitytoolkit#DeleteAccountResponse", # The fixed string "identitytoolkit#DeleteAccountResponse".
184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="downloadAccount">downloadAccount(body)</code>
189 <pre>Batch download user accounts.
190
191Args:
192 body: object, The request body. (required)
193 The object takes the form of:
194
195{ # Request to download user account in batch.
196 "nextPageToken": "A String", # The token for the next page. This should be taken from the previous response.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 "maxResults": 42, # The max number of results to return in the response.
199 }
200
201
202Returns:
203 An object of the form:
204
205 { # Respone of downloading accounts in batch.
206 "nextPageToken": "A String", # The next page token. To be used in a subsequent request to return the next page of results.
207 "kind": "identitytoolkit#DownloadAccountResponse", # The fixed string "identitytoolkit#DownloadAccountResponse".
208 "users": [ # The user accounts data.
209 { # Template for an individual account info.
210 "displayName": "A String", # The name of the user.
211 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]212 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 "photoUrl": "A String", # The URL of the user profile photo.
214 "emailVerified": True or False, # Whether the email has been verified.
215 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217 "version": 42, # Version of the user's password.
218 "providerUserInfo": [ # The IDP of the user.
219 {
220 "federatedId": "A String", # User's identifier at IDP.
221 "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.
222 "displayName": "A String", # The user's display name at the IDP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]223 "email": "A String", # User's email at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]224 "photoUrl": "A String", # The user's photo url at the IDP.
225 },
226 ],
227 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
228 "salt": "A String", # The user's password salt.
229 "email": "A String", # The email of the user.
230 },
231 ],
232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="getAccountInfo">getAccountInfo(body)</code>
237 <pre>Returns the account info.
238
239Args:
240 body: object, The request body. (required)
241 The object takes the form of:
242
243{ # Request to get the account information.
244 "idToken": "A String", # The GITKit token of the authenticated user.
245 "email": [ # The list of emails of the users to inquiry.
246 "A String",
247 ],
248 "localId": [ # The list of local ID's of the users to inquiry.
249 "A String",
250 ],
251 }
252
253
254Returns:
255 An object of the form:
256
257 { # Response of getting account information.
258 "kind": "identitytoolkit#GetAccountInfoResponse", # The fixed string "identitytoolkit#GetAccountInfoResponse".
259 "users": [ # The info of the users.
260 { # Template for an individual account info.
261 "displayName": "A String", # The name of the user.
262 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]263 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 "photoUrl": "A String", # The URL of the user profile photo.
265 "emailVerified": True or False, # Whether the email has been verified.
266 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]267 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "version": 42, # Version of the user's password.
269 "providerUserInfo": [ # The IDP of the user.
270 {
271 "federatedId": "A String", # User's identifier at IDP.
272 "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.
273 "displayName": "A String", # The user's display name at the IDP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 "email": "A String", # User's email at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 "photoUrl": "A String", # The user's photo url at the IDP.
276 },
277 ],
278 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
279 "salt": "A String", # The user's password salt.
280 "email": "A String", # The email of the user.
281 },
282 ],
283 }</pre>
284</div>
285
286<div class="method">
287 <code class="details" id="getOobConfirmationCode">getOobConfirmationCode(body)</code>
288 <pre>Get a code for user action confirmation.
289
290Args:
291 body: object, The request body. (required)
292 The object takes the form of:
293
294{ # Request of getting a code for user confirmation (reset password, change email etc.)
295 "kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".
296 "requestType": "A String", # The request type.
297 "idToken": "A String", # The user's Gitkit login token for email change.
298 "challenge": "A String", # The recaptcha challenge presented to the user.
299 "newEmail": "A String", # The new email if the code is for email change.
300 "userIp": "A String", # The IP address of the user.
301 "email": "A String", # The email of the user.
302 "captchaResp": "A String", # The recaptcha response from the user.
303 }
304
305
306Returns:
307 An object of the form:
308
309 { # Response of getting a code for user confirmation (reset password, change email etc.).
310 "kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".
311 "oobCode": "A String", # The code to be send to the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]312 "email": "A String", # The email address that the email is sent to.
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="getProjectConfig">getProjectConfig()</code>
318 <pre>Get project configuration.
319
320Args:
321
322Returns:
323 An object of the form:
324
325 { # Response of getting the project configuration.
326 "projectId": "A String", # Project ID of the relying party.
327 "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
328 "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
329 "idpConfig": [ # OAuth2 provider configuration.
330 { # Template for a single idp configuration.
331 "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
332 "enabled": True or False, # Whether this IDP is enabled.
333 "clientId": "A String", # OAuth2 client ID.
334 "provider": "A String", # OAuth2 provider.
335 },
336 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="getPublicKeys">getPublicKeys()</code>
342 <pre>Get token signing public key.
343
344Args:
345
346Returns:
347 An object of the form:
348
349 { # Respone of getting public keys.
350 "a_key": "A String",
351 }</pre>
352</div>
353
354<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]355 <code class="details" id="getRecaptchaParam">getRecaptchaParam()</code>
356 <pre>Get recaptcha secure param.
357
358Args:
359
360Returns:
361 An object of the form:
362
363 { # Response of getting recaptcha param.
364 "kind": "identitytoolkit#GetRecaptchaParamResponse", # The fixed string "identitytoolkit#GetRecaptchaParamResponse".
365 "recaptchaSiteKey": "A String", # Site key registered at recaptcha.
366 "recaptchaStoken": "A String", # The stoken field for the recaptcha widget, used to request captcha challenge.
367 }</pre>
368</div>
369
370<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]371 <code class="details" id="resetPassword">resetPassword(body)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]372 <pre>Reset password for a user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]373
374Args:
375 body: object, The request body. (required)
376 The object takes the form of:
377
378{ # Request to reset the password.
379 "newPassword": "A String", # The new password inputted by the user.
380 "oldPassword": "A String", # The old password inputted by the user.
381 "oobCode": "A String", # The confirmation code.
382 "email": "A String", # The email address of the user.
383 }
384
385
386Returns:
387 An object of the form:
388
389 { # Response of resetting the password.
390 "kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
391 "email": "A String", # The user's email.
392 }</pre>
393</div>
394
395<div class="method">
396 <code class="details" id="setAccountInfo">setAccountInfo(body)</code>
397 <pre>Set account info for a user.
398
399Args:
400 body: object, The request body. (required)
401 The object takes the form of:
402
403{ # Request to set the account information.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]404 "instanceId": "A String", # Instance id token of the app.
405 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 "displayName": "A String", # The name of the user.
407 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]408 "validSince": "A String", # Timestamp in seconds for valid login token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]409 "photoUrl": "A String", # The photo url of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]410 "captchaResponse": "A String", # Response to the captcha.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]411 "emailVerified": True or False, # Mark the email as verified or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]412 "provider": [ # The associated IDPs of the user.
413 "A String",
414 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]415 "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]416 "disableUser": True or False, # Whether to disable the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]417 "captchaChallenge": "A String", # The captcha challenge.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]418 "idToken": "A String", # The GITKit token of the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]419 "oobCode": "A String", # The out-of-band code of the change email request.
420 "password": "A String", # The new password of the user.
421 "email": "A String", # The email of the user.
422 }
423
424
425Returns:
426 An object of the form:
427
428 { # Respone of setting the account information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]429 "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
430 "displayName": "A String", # The name of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]431 "providerUserInfo": [ # The user's profiles at the associated IdPs.
432 {
433 "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.
434 "displayName": "A String", # The user's display name at the IDP.
435 "photoUrl": "A String", # The user's photo url at the IDP.
436 },
437 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]438 "photoUrl": "A String", # The photo url of the user.
439 "idToken": "A String", # The Gitkit id token to login the newly sign up user.
440 "newEmail": "A String", # The new email the user attempts to change to.
441 "email": "A String", # The email of the user.
442 }</pre>
443</div>
444
445<div class="method">
446 <code class="details" id="signOutUser">signOutUser(body)</code>
447 <pre>Sign out user.
448
449Args:
450 body: object, The request body. (required)
451 The object takes the form of:
452
453{ # Request to sign out user.
454 "instanceId": "A String", # Instance id token of the app.
455 "localId": "A String", # The local ID of the user.
456 }
457
458
459Returns:
460 An object of the form:
461
462 { # Response of signing out user.
463 "localId": "A String", # The local ID of the user.
464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="signupNewUser">signupNewUser(body)</code>
469 <pre>Signup new user.
470
471Args:
472 body: object, The request body. (required)
473 The object takes the form of:
474
475{ # Request to signup new user, create anonymous user or anonymous user reauth.
476 "instanceId": "A String", # Instance id token of the app.
477 "displayName": "A String", # The name of the user.
478 "captchaResponse": "A String", # Response to the captcha.
479 "idToken": "A String", # The GITKit token of the authenticated user.
480 "captchaChallenge": "A String", # The captcha challenge.
481 "password": "A String", # The new password of the user.
482 "email": "A String", # The email of the user.
483 }
484
485
486Returns:
487 An object of the form:
488
489 { # Response of signing up new user, creating anonymous user or anonymous user reauth.
490 "idToken": "A String", # The Gitkit id token to login the newly sign up user.
491 "kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".
492 "displayName": "A String", # The name of the user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]493 "email": "A String", # The email of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]494 }</pre>
495</div>
496
497<div class="method">
498 <code class="details" id="uploadAccount">uploadAccount(body)</code>
499 <pre>Batch upload existing user accounts.
500
501Args:
502 body: object, The request body. (required)
503 The object takes the form of:
504
505{ # Request to upload user account in batch.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]506 "hashAlgorithm": "A String", # The password hash algorithm.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]507 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]508 "users": [ # The account info to be stored.
509 { # Template for an individual account info.
510 "displayName": "A String", # The name of the user.
511 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]512 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]513 "photoUrl": "A String", # The URL of the user profile photo.
514 "emailVerified": True or False, # Whether the email has been verified.
515 "passwordHash": "A String", # The user's hashed password.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]516 "disabled": True or False, # Whether the user is disabled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]517 "version": 42, # Version of the user's password.
518 "providerUserInfo": [ # The IDP of the user.
519 {
520 "federatedId": "A String", # User's identifier at IDP.
521 "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.
522 "displayName": "A String", # The user's display name at the IDP.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]523 "email": "A String", # User's email at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]524 "photoUrl": "A String", # The user's photo url at the IDP.
525 },
526 ],
527 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
528 "salt": "A String", # The user's password salt.
529 "email": "A String", # The email of the user.
530 },
531 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]532 "signerKey": "A String", # The key for to hash the password.
533 "memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
534 "saltSeparator": "A String", # The salt separator.
535 "rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 }
537
538
539Returns:
540 An object of the form:
541
542 { # Respone of uploading accounts in batch.
543 "kind": "identitytoolkit#UploadAccountResponse", # The fixed string "identitytoolkit#UploadAccountResponse".
544 "error": [ # The error encountered while processing the account info.
545 {
546 "index": 42, # The index of the malformed account, starting from 0.
547 "message": "A String", # Detailed error message for the account info.
548 },
549 ],
550 }</pre>
551</div>
552
553<div class="method">
554 <code class="details" id="verifyAssertion">verifyAssertion(body)</code>
555 <pre>Verifies the assertion returned by the IdP.
556
557Args:
558 body: object, The request body. (required)
559 The object takes the form of:
560
561{ # Request to verify the IDP assertion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]562 "postBody": "A String", # The post body if the request is a HTTP POST.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]563 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
564 "instanceId": "A String", # Instance id token of the app.
565 "idToken": "A String", # The GITKit token of the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]566 "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]567 "sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.
568 "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
569 "returnRefreshToken": True or False, # Whether to return refresh tokens.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]570 }
571
572
573Returns:
574 An object of the form:
575
576 { # Response of verifying the IDP assertion.
577 "federatedId": "A String", # The unique ID identifies the IdP account.
578 "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
579 "photoUrl": "A String", # The URI of the public accessible profiel picture.
580 "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.
581 "appScheme": "A String", # The custom scheme used by mobile app.
582 "verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
583 "A String",
584 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]585 "needEmail": True or False, # Whether need client to supply email to complete the federated login flow.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]586 "dateOfBirth": "A String", # The birth date of the IdP account.
587 "nickName": "A String", # The nick name of the user.
588 "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]589 "oauthAccessToken": "A String", # The OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]590 "language": "A String", # The language preference of the user.
591 "needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
592 "fullName": "A String", # The full name of the user.
593 "kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".
594 "idToken": "A String", # The ID token.
595 "displayName": "A String", # The display name of the user.
596 "appInstallationUrl": "A String", # URL for OTA app installation.
597 "firstName": "A String", # The first name of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]598 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]599 "emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
600 "oauthScope": "A String", # The scope for the OpenID OAuth extension.
601 "oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]602 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]603 "originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]604 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]605 "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
606 "lastName": "A String", # The last name of the user.
607 "action": "A String", # The action code.
608 "timeZone": "A String", # The timezone of the user.
609 "emailRecycled": True or False, # It's true if the email is recycled.
610 }</pre>
611</div>
612
613<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]614 <code class="details" id="verifyCustomToken">verifyCustomToken(body)</code>
615 <pre>Verifies the developer asserted ID token.
616
617Args:
618 body: object, The request body. (required)
619 The object takes the form of:
620
621{ # Request to verify a custom token
622 "instanceId": "A String", # Instance id token of the app.
623 "token": "A String", # The custom token to verify
624 }
625
626
627Returns:
628 An object of the form:
629
630 { # Response from verifying a custom token
631 "idToken": "A String", # The GITKit token for authenticated user.
632 "kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".
633 }</pre>
634</div>
635
636<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]637 <code class="details" id="verifyPassword">verifyPassword(body)</code>
638 <pre>Verifies the user entered password.
639
640Args:
641 body: object, The request body. (required)
642 The object takes the form of:
643
644{ # Request to verify the password.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]645 "instanceId": "A String", # Instance id token of the app.
646 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]647 "captchaResponse": "A String", # Response to the captcha.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]648 "idToken": "A String", # The GITKit token of the authenticated user.
649 "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]650 "captchaChallenge": "A String", # The captcha challenge.
651 "password": "A String", # The password inputed by the user.
652 "email": "A String", # The email of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]653 }
654
655
656Returns:
657 An object of the form:
658
659 { # Request of verifying the password.
660 "kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".
661 "displayName": "A String", # The name of the user.
662 "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]663 "oauthAccessToken": "A String", # The OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]664 "photoUrl": "A String", # The URI of the user's photo at IdP
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]665 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]666 "idToken": "A String", # The GITKit token for authenticated user.
667 "registered": True or False, # Whether the email is registered.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]668 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]669 "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
670 }</pre>
671</div>
672
673</body></html>