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