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