blob: 702e49e8074e50bdb7db0db4215efcd2633d1652 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#createAuthUri">createAuthUri(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<p class="firstline">Creates the URI used by the IdP to authenticate the user.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#deleteAccount">deleteAccount(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Delete user account.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#downloadAccount">downloadAccount(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Batch download user accounts.</p>
86<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040087 <code><a href="#downloadAccount_next">downloadAccount_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#emailLinkSignin">emailLinkSignin(body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Reset password for a user.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#getAccountInfo">getAccountInfo(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040094<p class="firstline">Returns the account info.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#getOobConfirmationCode">getOobConfirmationCode(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040097<p class="firstline">Get a code for user action confirmation.</p>
98<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070099 <code><a href="#getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800100<p class="firstline">Get project configuration.</p>
101<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400102 <code><a href="#getPublicKeys">getPublicKeys()</a></code></p>
103<p class="firstline">Get token signing public key.</p>
104<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000105 <code><a href="#getRecaptchaParam">getRecaptchaParam()</a></code></p>
106<p class="firstline">Get recaptcha secure param.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#resetPassword">resetPassword(body=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700109<p class="firstline">Reset password for a user.</p>
John Asmuth614db982014-04-24 15:46:26 -0400110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#sendVerificationCode">sendVerificationCode(body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112<p class="firstline">Send SMS verification code.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700114 <code><a href="#setAccountInfo">setAccountInfo(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400115<p class="firstline">Set account info for a user.</p>
116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 <code><a href="#setProjectConfig">setProjectConfig(body=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700118<p class="firstline">Set project configuration.</p>
119<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700120 <code><a href="#signOutUser">signOutUser(body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800121<p class="firstline">Sign out user.</p>
122<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700123 <code><a href="#signupNewUser">signupNewUser(body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800124<p class="firstline">Signup new user.</p>
125<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 <code><a href="#uploadAccount">uploadAccount(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400127<p class="firstline">Batch upload existing user accounts.</p>
128<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700129 <code><a href="#verifyAssertion">verifyAssertion(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400130<p class="firstline">Verifies the assertion returned by the IdP.</p>
131<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700132 <code><a href="#verifyCustomToken">verifyCustomToken(body=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800133<p class="firstline">Verifies the developer asserted ID token.</p>
134<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700135 <code><a href="#verifyPassword">verifyPassword(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400136<p class="firstline">Verifies the user entered password.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700137<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 <code><a href="#verifyPhoneNumber">verifyPhoneNumber(body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139<p class="firstline">Verifies ownership of a phone number and creates/updates the user account accordingly.</p>
John Asmuth614db982014-04-24 15:46:26 -0400140<h3>Method Details</h3>
141<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700142 <code class="details" id="createAuthUri">createAuthUri(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400143 <pre>Creates the URI used by the IdP to authenticate the user.
144
145Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700146 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400147 The object takes the form of:
148
149{ # Request to get the IDP authentication URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700150 &quot;appId&quot;: &quot;A String&quot;, # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
151 &quot;authFlowType&quot;: &quot;A String&quot;, # Explicitly specify the auth flow type. Currently only support &quot;CODE_FLOW&quot; type. The field is only used for Google provider.
152 &quot;clientId&quot;: &quot;A String&quot;, # The relying party OAuth client ID.
153 &quot;context&quot;: &quot;A String&quot;, # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
154 &quot;continueUri&quot;: &quot;A String&quot;, # The URI to which the IDP redirects the user after the federated login flow.
155 &quot;customParameter&quot;: { # The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.
156 &quot;a_key&quot;: &quot;A String&quot;, # The customized query parameter.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700157 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 &quot;hostedDomain&quot;: &quot;A String&quot;, # The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
159 &quot;identifier&quot;: &quot;A String&quot;, # The email or federated ID of the user.
160 &quot;oauthConsumerKey&quot;: &quot;A String&quot;, # The developer&#x27;s consumer key for OpenId OAuth Extension
161 &quot;oauthScope&quot;: &quot;A String&quot;, # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
162 &quot;openidRealm&quot;: &quot;A String&quot;, # Optional realm for OpenID protocol. The sub string &quot;scheme://domain:port&quot; of the param &quot;continueUri&quot; is used if this is not set.
163 &quot;otaApp&quot;: &quot;A String&quot;, # The native app package for OTA installation.
164 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For white listed IdPs it&#x27;s a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it&#x27;s the OP identifier.
165 &quot;sessionId&quot;: &quot;A String&quot;, # The session_id passed by client.
166 &quot;tenantId&quot;: &quot;A String&quot;, # For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
167 &quot;tenantProjectNumber&quot;: &quot;A String&quot;, # Tenant project number to be used for idp discovery.
John Asmuth614db982014-04-24 15:46:26 -0400168 }
169
170
171Returns:
172 An object of the form:
173
174 { # Response of creating the IDP authentication URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 &quot;allProviders&quot;: [ # all providers the user has once used to do federated login
176 &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800177 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &quot;authUri&quot;: &quot;A String&quot;, # The URI used by the IDP to authenticate the user.
179 &quot;captchaRequired&quot;: True or False, # True if captcha is required.
180 &quot;forExistingProvider&quot;: True or False, # True if the authUri is for user&#x27;s existing provider.
181 &quot;kind&quot;: &quot;identitytoolkit#CreateAuthUriResponse&quot;, # The fixed string identitytoolkit#CreateAuthUriResponse&quot;.
182 &quot;providerId&quot;: &quot;A String&quot;, # The provider ID of the auth URI.
183 &quot;registered&quot;: True or False, # Whether the user is registered if the identifier is an email.
184 &quot;sessionId&quot;: &quot;A String&quot;, # Session ID which should be passed in the following verifyAssertion request.
185 &quot;signinMethods&quot;: [ # All sign-in methods this user has used.
186 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 ],
John Asmuth614db982014-04-24 15:46:26 -0400188 }</pre>
189</div>
190
191<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700192 <code class="details" id="deleteAccount">deleteAccount(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400193 <pre>Delete user account.
194
195Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700196 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400197 The object takes the form of:
198
199{ # Request to delete account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
201 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token or STS id token of the authenticated user.
202 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
John Asmuth614db982014-04-24 15:46:26 -0400203 }
204
205
206Returns:
207 An object of the form:
208
209 { # Respone of deleting account.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 &quot;kind&quot;: &quot;identitytoolkit#DeleteAccountResponse&quot;, # The fixed string &quot;identitytoolkit#DeleteAccountResponse&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400211 }</pre>
212</div>
213
214<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700215 <code class="details" id="downloadAccount">downloadAccount(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400216 <pre>Batch download user accounts.
217
218Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700219 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400220 The object takes the form of:
221
222{ # Request to download user account in batch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
224 &quot;maxResults&quot;: 42, # The max number of results to return in the response.
225 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the next page. This should be taken from the previous response.
226 &quot;targetProjectId&quot;: &quot;A String&quot;, # Specify which project (field value is actually project id) to operate. Only used when provided credential.
John Asmuth614db982014-04-24 15:46:26 -0400227 }
228
229
230Returns:
231 An object of the form:
232
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400233 { # Response of downloading accounts in batch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700234 &quot;kind&quot;: &quot;identitytoolkit#DownloadAccountResponse&quot;, # The fixed string &quot;identitytoolkit#DownloadAccountResponse&quot;.
235 &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token. To be used in a subsequent request to return the next page of results.
236 &quot;users&quot;: [ # The user accounts data.
John Asmuth614db982014-04-24 15:46:26 -0400237 { # Template for an individual account info.
Bu Sun Kim65020912020-05-20 12:08:20 -0700238 &quot;createdAt&quot;: &quot;A String&quot;, # User creation timestamp.
239 &quot;customAttributes&quot;: &quot;A String&quot;, # The custom attributes to be set in the user&#x27;s id token.
240 &quot;customAuth&quot;: True or False, # Whether the user is authenticated by the developer.
241 &quot;disabled&quot;: True or False, # Whether the user is disabled.
242 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
243 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
244 &quot;emailVerified&quot;: True or False, # Whether the email has been verified.
245 &quot;lastLoginAt&quot;: &quot;A String&quot;, # last login timestamp.
246 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
247 &quot;passwordHash&quot;: &quot;A String&quot;, # The user&#x27;s hashed password.
248 &quot;passwordUpdatedAt&quot;: 3.14, # The timestamp when the password was last updated.
249 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
250 &quot;photoUrl&quot;: &quot;A String&quot;, # The URL of the user profile photo.
251 &quot;providerUserInfo&quot;: [ # The IDP of the user.
John Asmuth614db982014-04-24 15:46:26 -0400252 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name at the IDP.
254 &quot;email&quot;: &quot;A String&quot;, # User&#x27;s email at IDP.
255 &quot;federatedId&quot;: &quot;A String&quot;, # User&#x27;s identifier at IDP.
256 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
257 &quot;photoUrl&quot;: &quot;A String&quot;, # The user&#x27;s photo url at the IDP.
258 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For white listed IdPs it&#x27;s a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it&#x27;s the OP identifier.
259 &quot;rawId&quot;: &quot;A String&quot;, # User&#x27;s raw identifier directly returned from IDP.
260 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400261 },
262 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 &quot;rawPassword&quot;: &quot;A String&quot;, # The user&#x27;s plain text password.
264 &quot;salt&quot;: &quot;A String&quot;, # The user&#x27;s password salt.
265 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
266 &quot;validSince&quot;: &quot;A String&quot;, # Timestamp in seconds for valid login token.
267 &quot;version&quot;: 42, # Version of the user&#x27;s password.
John Asmuth614db982014-04-24 15:46:26 -0400268 },
269 ],
270 }</pre>
271</div>
272
273<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400274 <code class="details" id="downloadAccount_next">downloadAccount_next(previous_request, previous_response)</code>
275 <pre>Retrieves the next page of results.
276
277Args:
278 previous_request: The request for the previous page. (required)
279 previous_response: The response from the request for the previous page. (required)
280
281Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400283 page. Returns None if there are no more items in the collection.
284 </pre>
285</div>
286
287<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700288 <code class="details" id="emailLinkSignin">emailLinkSignin(body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700289 <pre>Reset password for a user.
290
291Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700292 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700293 The object takes the form of:
294
295{ # Request to sign in with email.
Bu Sun Kim65020912020-05-20 12:08:20 -0700296 &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
297 &quot;idToken&quot;: &quot;A String&quot;, # Token for linking flow.
298 &quot;oobCode&quot;: &quot;A String&quot;, # The confirmation code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 }
300
301
302Returns:
303 An object of the form:
304
305 { # Response of email signIn.
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email.
307 &quot;expiresIn&quot;: &quot;A String&quot;, # Expiration time of STS id token in seconds.
308 &quot;idToken&quot;: &quot;A String&quot;, # The STS id token to login the newly signed in user.
309 &quot;isNewUser&quot;: True or False, # Whether the user is new.
310 &quot;kind&quot;: &quot;identitytoolkit#EmailLinkSigninResponse&quot;, # The fixed string &quot;identitytoolkit#EmailLinkSigninResponse&quot;.
311 &quot;localId&quot;: &quot;A String&quot;, # The RP local ID of the user.
312 &quot;refreshToken&quot;: &quot;A String&quot;, # The refresh token for the signed in user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 }</pre>
314</div>
315
316<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 <code class="details" id="getAccountInfo">getAccountInfo(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400318 <pre>Returns the account info.
319
320Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400322 The object takes the form of:
323
324{ # Request to get the account information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700325 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
326 &quot;email&quot;: [ # The list of emails of the users to inquiry.
327 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700328 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700329 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token of the authenticated user.
330 &quot;localId&quot;: [ # The list of local ID&#x27;s of the users to inquiry.
331 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400332 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700333 &quot;phoneNumber&quot;: [ # Privileged caller can query users by specified phone number.
334 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400335 ],
336 }
337
338
339Returns:
340 An object of the form:
341
342 { # Response of getting account information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 &quot;kind&quot;: &quot;identitytoolkit#GetAccountInfoResponse&quot;, # The fixed string &quot;identitytoolkit#GetAccountInfoResponse&quot;.
344 &quot;users&quot;: [ # The info of the users.
John Asmuth614db982014-04-24 15:46:26 -0400345 { # Template for an individual account info.
Bu Sun Kim65020912020-05-20 12:08:20 -0700346 &quot;createdAt&quot;: &quot;A String&quot;, # User creation timestamp.
347 &quot;customAttributes&quot;: &quot;A String&quot;, # The custom attributes to be set in the user&#x27;s id token.
348 &quot;customAuth&quot;: True or False, # Whether the user is authenticated by the developer.
349 &quot;disabled&quot;: True or False, # Whether the user is disabled.
350 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
351 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
352 &quot;emailVerified&quot;: True or False, # Whether the email has been verified.
353 &quot;lastLoginAt&quot;: &quot;A String&quot;, # last login timestamp.
354 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
355 &quot;passwordHash&quot;: &quot;A String&quot;, # The user&#x27;s hashed password.
356 &quot;passwordUpdatedAt&quot;: 3.14, # The timestamp when the password was last updated.
357 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
358 &quot;photoUrl&quot;: &quot;A String&quot;, # The URL of the user profile photo.
359 &quot;providerUserInfo&quot;: [ # The IDP of the user.
John Asmuth614db982014-04-24 15:46:26 -0400360 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700361 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name at the IDP.
362 &quot;email&quot;: &quot;A String&quot;, # User&#x27;s email at IDP.
363 &quot;federatedId&quot;: &quot;A String&quot;, # User&#x27;s identifier at IDP.
364 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
365 &quot;photoUrl&quot;: &quot;A String&quot;, # The user&#x27;s photo url at the IDP.
366 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For white listed IdPs it&#x27;s a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it&#x27;s the OP identifier.
367 &quot;rawId&quot;: &quot;A String&quot;, # User&#x27;s raw identifier directly returned from IDP.
368 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400369 },
370 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700371 &quot;rawPassword&quot;: &quot;A String&quot;, # The user&#x27;s plain text password.
372 &quot;salt&quot;: &quot;A String&quot;, # The user&#x27;s password salt.
373 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
374 &quot;validSince&quot;: &quot;A String&quot;, # Timestamp in seconds for valid login token.
375 &quot;version&quot;: 42, # Version of the user&#x27;s password.
John Asmuth614db982014-04-24 15:46:26 -0400376 },
377 ],
378 }</pre>
379</div>
380
381<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700382 <code class="details" id="getOobConfirmationCode">getOobConfirmationCode(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400383 <pre>Get a code for user action confirmation.
384
385Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700386 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400387 The object takes the form of:
388
389{ # Request of getting a code for user confirmation (reset password, change email etc.)
Bu Sun Kim65020912020-05-20 12:08:20 -0700390 &quot;androidInstallApp&quot;: True or False, # whether or not to install the android app on the device where the link is opened
391 &quot;androidMinimumVersion&quot;: &quot;A String&quot;, # minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app
392 &quot;androidPackageName&quot;: &quot;A String&quot;, # android package name of the android app to handle the action code
393 &quot;canHandleCodeInApp&quot;: True or False, # whether or not the app can handle the oob code without first going to web
394 &quot;captchaResp&quot;: &quot;A String&quot;, # The recaptcha response from the user.
395 &quot;challenge&quot;: &quot;A String&quot;, # The recaptcha challenge presented to the user.
396 &quot;continueUrl&quot;: &quot;A String&quot;, # The url to continue to the Gitkit app
397 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
398 &quot;iOSAppStoreId&quot;: &quot;A String&quot;, # iOS app store id to download the app if it&#x27;s not already installed
399 &quot;iOSBundleId&quot;: &quot;A String&quot;, # the iOS bundle id of iOS app to handle the action code
400 &quot;idToken&quot;: &quot;A String&quot;, # The user&#x27;s Gitkit login token for email change.
401 &quot;kind&quot;: &quot;identitytoolkit#relyingparty&quot;, # The fixed string &quot;identitytoolkit#relyingparty&quot;.
402 &quot;newEmail&quot;: &quot;A String&quot;, # The new email if the code is for email change.
403 &quot;requestType&quot;: &quot;A String&quot;, # The request type.
404 &quot;userIp&quot;: &quot;A String&quot;, # The IP address of the user.
John Asmuth614db982014-04-24 15:46:26 -0400405 }
406
407
408Returns:
409 An object of the form:
410
411 { # Response of getting a code for user confirmation (reset password, change email etc.).
Bu Sun Kim65020912020-05-20 12:08:20 -0700412 &quot;email&quot;: &quot;A String&quot;, # The email address that the email is sent to.
413 &quot;kind&quot;: &quot;identitytoolkit#GetOobConfirmationCodeResponse&quot;, # The fixed string &quot;identitytoolkit#GetOobConfirmationCodeResponse&quot;.
414 &quot;oobCode&quot;: &quot;A String&quot;, # The code to be send to the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800415 }</pre>
416</div>
417
418<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700419 <code class="details" id="getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800420 <pre>Get project configuration.
421
422Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700423 delegatedProjectNumber: string, Delegated GCP project number of the request.
424 projectNumber: string, GCP project number of the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800425
426Returns:
427 An object of the form:
428
429 { # Response of getting the project configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700430 &quot;allowPasswordUser&quot;: True or False, # Whether to allow password user sign in or sign up.
431 &quot;apiKey&quot;: &quot;A String&quot;, # Browser API key, needed when making http request to Apiary.
432 &quot;authorizedDomains&quot;: [ # Authorized domains.
433 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700434 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700435 &quot;changeEmailTemplate&quot;: { # Template for an email template. # Change email template.
436 &quot;body&quot;: &quot;A String&quot;, # Email body.
437 &quot;format&quot;: &quot;A String&quot;, # Email body format.
438 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
439 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
440 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
441 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700442 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700443 &quot;dynamicLinksDomain&quot;: &quot;A String&quot;,
444 &quot;enableAnonymousUser&quot;: True or False, # Whether anonymous user is enabled.
445 &quot;idpConfig&quot;: [ # OAuth2 provider configuration.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800446 { # Template for a single idp configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700447 &quot;clientId&quot;: &quot;A String&quot;, # OAuth2 client ID.
448 &quot;enabled&quot;: True or False, # Whether this IDP is enabled.
449 &quot;experimentPercent&quot;: 42, # Percent of users who will be prompted/redirected federated login for this IDP.
450 &quot;provider&quot;: &quot;A String&quot;, # OAuth2 provider.
451 &quot;secret&quot;: &quot;A String&quot;, # OAuth2 client secret.
452 &quot;whitelistedAudiences&quot;: [ # Whitelisted client IDs for audience check.
453 &quot;A String&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700454 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800455 },
456 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700457 &quot;legacyResetPasswordTemplate&quot;: { # Template for an email template. # Legacy reset password email template.
458 &quot;body&quot;: &quot;A String&quot;, # Email body.
459 &quot;format&quot;: &quot;A String&quot;, # Email body format.
460 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
461 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
462 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
463 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
464 },
465 &quot;projectId&quot;: &quot;A String&quot;, # Project ID of the relying party.
466 &quot;resetPasswordTemplate&quot;: { # Template for an email template. # Reset password email template.
467 &quot;body&quot;: &quot;A String&quot;, # Email body.
468 &quot;format&quot;: &quot;A String&quot;, # Email body format.
469 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
470 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
471 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
472 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
473 },
474 &quot;useEmailSending&quot;: True or False, # Whether to use email sending provided by Firebear.
475 &quot;verifyEmailTemplate&quot;: { # Template for an email template. # Verify email template.
476 &quot;body&quot;: &quot;A String&quot;, # Email body.
477 &quot;format&quot;: &quot;A String&quot;, # Email body format.
478 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
479 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
480 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
481 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
482 },
John Asmuth614db982014-04-24 15:46:26 -0400483 }</pre>
484</div>
485
486<div class="method">
487 <code class="details" id="getPublicKeys">getPublicKeys()</code>
488 <pre>Get token signing public key.
489
490Args:
491
492Returns:
493 An object of the form:
494
495 { # Respone of getting public keys.
Bu Sun Kim65020912020-05-20 12:08:20 -0700496 &quot;a_key&quot;: &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400497 }</pre>
498</div>
499
500<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000501 <code class="details" id="getRecaptchaParam">getRecaptchaParam()</code>
502 <pre>Get recaptcha secure param.
503
504Args:
505
506Returns:
507 An object of the form:
508
509 { # Response of getting recaptcha param.
Bu Sun Kim65020912020-05-20 12:08:20 -0700510 &quot;kind&quot;: &quot;identitytoolkit#GetRecaptchaParamResponse&quot;, # The fixed string &quot;identitytoolkit#GetRecaptchaParamResponse&quot;.
511 &quot;recaptchaSiteKey&quot;: &quot;A String&quot;, # Site key registered at recaptcha.
512 &quot;recaptchaStoken&quot;: &quot;A String&quot;, # The stoken field for the recaptcha widget, used to request captcha challenge.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000513 }</pre>
514</div>
515
516<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700517 <code class="details" id="resetPassword">resetPassword(body=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700518 <pre>Reset password for a user.
John Asmuth614db982014-04-24 15:46:26 -0400519
520Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700521 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400522 The object takes the form of:
523
524{ # Request to reset the password.
Bu Sun Kim65020912020-05-20 12:08:20 -0700525 &quot;email&quot;: &quot;A String&quot;, # The email address of the user.
526 &quot;newPassword&quot;: &quot;A String&quot;, # The new password inputted by the user.
527 &quot;oldPassword&quot;: &quot;A String&quot;, # The old password inputted by the user.
528 &quot;oobCode&quot;: &quot;A String&quot;, # The confirmation code.
John Asmuth614db982014-04-24 15:46:26 -0400529 }
530
531
532Returns:
533 An object of the form:
534
535 { # Response of resetting the password.
Bu Sun Kim65020912020-05-20 12:08:20 -0700536 &quot;email&quot;: &quot;A String&quot;, # The user&#x27;s email. If the out-of-band code is for email recovery, the user&#x27;s original email.
537 &quot;kind&quot;: &quot;identitytoolkit#ResetPasswordResponse&quot;, # The fixed string &quot;identitytoolkit#ResetPasswordResponse&quot;.
538 &quot;newEmail&quot;: &quot;A String&quot;, # If the out-of-band code is for email recovery, the user&#x27;s new email.
539 &quot;requestType&quot;: &quot;A String&quot;, # The request type.
John Asmuth614db982014-04-24 15:46:26 -0400540 }</pre>
541</div>
542
543<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700544 <code class="details" id="sendVerificationCode">sendVerificationCode(body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700545 <pre>Send SMS verification code.
546
547Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700548 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700549 The object takes the form of:
550
551{ # Request for Identitytoolkit-SendVerificationCode
Bu Sun Kim65020912020-05-20 12:08:20 -0700552 &quot;iosReceipt&quot;: &quot;A String&quot;, # Receipt of successful app token validation with APNS.
553 &quot;iosSecret&quot;: &quot;A String&quot;, # Secret delivered to iOS app via APNS.
554 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number to send the verification code to in E.164 format.
555 &quot;recaptchaToken&quot;: &quot;A String&quot;, # Recaptcha solution.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700556 }
557
558
559Returns:
560 An object of the form:
561
562 { # Response for Identitytoolkit-SendVerificationCode
Bu Sun Kim65020912020-05-20 12:08:20 -0700563 &quot;sessionInfo&quot;: &quot;A String&quot;, # Encrypted session information
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 }</pre>
565</div>
566
567<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700568 <code class="details" id="setAccountInfo">setAccountInfo(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400569 <pre>Set account info for a user.
570
571Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700572 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400573 The object takes the form of:
574
575{ # Request to set the account information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700576 &quot;captchaChallenge&quot;: &quot;A String&quot;, # The captcha challenge.
577 &quot;captchaResponse&quot;: &quot;A String&quot;, # Response to the captcha.
578 &quot;createdAt&quot;: &quot;A String&quot;, # The timestamp when the account is created.
579 &quot;customAttributes&quot;: &quot;A String&quot;, # The custom attributes to be set in the user&#x27;s id token.
580 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
581 &quot;deleteAttribute&quot;: [ # The attributes users request to delete.
582 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400583 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700584 &quot;deleteProvider&quot;: [ # The IDPs the user request to delete.
585 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700586 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700587 &quot;disableUser&quot;: True or False, # Whether to disable the user.
588 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
589 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
590 &quot;emailVerified&quot;: True or False, # Mark the email as verified or not.
591 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token of the authenticated user.
592 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
593 &quot;lastLoginAt&quot;: &quot;A String&quot;, # Last login timestamp.
594 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
595 &quot;oobCode&quot;: &quot;A String&quot;, # The out-of-band code of the change email request.
596 &quot;password&quot;: &quot;A String&quot;, # The new password of the user.
597 &quot;phoneNumber&quot;: &quot;A String&quot;, # Privileged caller can update user with specified phone number.
598 &quot;photoUrl&quot;: &quot;A String&quot;, # The photo url of the user.
599 &quot;provider&quot;: [ # The associated IDPs of the user.
600 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700601 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700602 &quot;returnSecureToken&quot;: True or False, # Whether return sts id token and refresh token instead of gitkit token.
603 &quot;upgradeToFederatedLogin&quot;: True or False, # Mark the user to upgrade to federated login.
604 &quot;validSince&quot;: &quot;A String&quot;, # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400605 }
606
607
608Returns:
609 An object of the form:
610
611 { # Respone of setting the account information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700612 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
613 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
614 &quot;emailVerified&quot;: True or False, # If email has been verified.
615 &quot;expiresIn&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
616 &quot;idToken&quot;: &quot;A String&quot;, # The Gitkit id token to login the newly sign up user.
617 &quot;kind&quot;: &quot;identitytoolkit#SetAccountInfoResponse&quot;, # The fixed string &quot;identitytoolkit#SetAccountInfoResponse&quot;.
618 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
619 &quot;newEmail&quot;: &quot;A String&quot;, # The new email the user attempts to change to.
620 &quot;passwordHash&quot;: &quot;A String&quot;, # The user&#x27;s hashed password.
621 &quot;photoUrl&quot;: &quot;A String&quot;, # The photo url of the user.
622 &quot;providerUserInfo&quot;: [ # The user&#x27;s profiles at the associated IdPs.
John Asmuth614db982014-04-24 15:46:26 -0400623 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700624 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name at the IDP.
625 &quot;federatedId&quot;: &quot;A String&quot;, # User&#x27;s identifier at IDP.
626 &quot;photoUrl&quot;: &quot;A String&quot;, # The user&#x27;s photo url at the IDP.
627 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For whitelisted IdPs it&#x27;s a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it&#x27;s the OP identifier.
John Asmuth614db982014-04-24 15:46:26 -0400628 },
629 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700630 &quot;refreshToken&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be refresh token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800631 }</pre>
632</div>
633
634<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700635 <code class="details" id="setProjectConfig">setProjectConfig(body=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700636 <pre>Set project configuration.
637
638Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700639 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700640 The object takes the form of:
641
642{ # Request to set the project configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700643 &quot;allowPasswordUser&quot;: True or False, # Whether to allow password user sign in or sign up.
644 &quot;apiKey&quot;: &quot;A String&quot;, # Browser API key, needed when making http request to Apiary.
645 &quot;authorizedDomains&quot;: [ # Authorized domains for widget redirect.
646 &quot;A String&quot;,
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700647 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700648 &quot;changeEmailTemplate&quot;: { # Template for an email template. # Change email template.
649 &quot;body&quot;: &quot;A String&quot;, # Email body.
650 &quot;format&quot;: &quot;A String&quot;, # Email body format.
651 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
652 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
653 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
654 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700655 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700656 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
657 &quot;enableAnonymousUser&quot;: True or False, # Whether to enable anonymous user.
658 &quot;idpConfig&quot;: [ # Oauth2 provider configuration.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700659 { # Template for a single idp configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700660 &quot;clientId&quot;: &quot;A String&quot;, # OAuth2 client ID.
661 &quot;enabled&quot;: True or False, # Whether this IDP is enabled.
662 &quot;experimentPercent&quot;: 42, # Percent of users who will be prompted/redirected federated login for this IDP.
663 &quot;provider&quot;: &quot;A String&quot;, # OAuth2 provider.
664 &quot;secret&quot;: &quot;A String&quot;, # OAuth2 client secret.
665 &quot;whitelistedAudiences&quot;: [ # Whitelisted client IDs for audience check.
666 &quot;A String&quot;,
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700667 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700668 },
669 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700670 &quot;legacyResetPasswordTemplate&quot;: { # Template for an email template. # Legacy reset password email template.
671 &quot;body&quot;: &quot;A String&quot;, # Email body.
672 &quot;format&quot;: &quot;A String&quot;, # Email body format.
673 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
674 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
675 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
676 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
677 },
678 &quot;resetPasswordTemplate&quot;: { # Template for an email template. # Reset password email template.
679 &quot;body&quot;: &quot;A String&quot;, # Email body.
680 &quot;format&quot;: &quot;A String&quot;, # Email body format.
681 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
682 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
683 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
684 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
685 },
686 &quot;useEmailSending&quot;: True or False, # Whether to use email sending provided by Firebear.
687 &quot;verifyEmailTemplate&quot;: { # Template for an email template. # Verify email template.
688 &quot;body&quot;: &quot;A String&quot;, # Email body.
689 &quot;format&quot;: &quot;A String&quot;, # Email body format.
690 &quot;from&quot;: &quot;A String&quot;, # From address of the email.
691 &quot;fromDisplayName&quot;: &quot;A String&quot;, # From display name.
692 &quot;replyTo&quot;: &quot;A String&quot;, # Reply-to address.
693 &quot;subject&quot;: &quot;A String&quot;, # Subject of the email.
694 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700695 }
696
697
698Returns:
699 An object of the form:
700
701 { # Response of setting the project configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700702 &quot;projectId&quot;: &quot;A String&quot;, # Project ID of the relying party.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700703 }</pre>
704</div>
705
706<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700707 <code class="details" id="signOutUser">signOutUser(body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800708 <pre>Sign out user.
709
710Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700711 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800712 The object takes the form of:
713
714{ # Request to sign out user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700715 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
716 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800717 }
718
719
720Returns:
721 An object of the form:
722
723 { # Response of signing out user.
Bu Sun Kim65020912020-05-20 12:08:20 -0700724 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800725 }</pre>
726</div>
727
728<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700729 <code class="details" id="signupNewUser">signupNewUser(body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800730 <pre>Signup new user.
731
732Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700733 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800734 The object takes the form of:
735
736{ # Request to signup new user, create anonymous user or anonymous user reauth.
Bu Sun Kim65020912020-05-20 12:08:20 -0700737 &quot;captchaChallenge&quot;: &quot;A String&quot;, # The captcha challenge.
738 &quot;captchaResponse&quot;: &quot;A String&quot;, # Response to the captcha.
739 &quot;disabled&quot;: True or False, # Whether to disable the user. Only can be used by service account.
740 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
741 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
742 &quot;emailVerified&quot;: True or False, # Mark the email as verified or not. Only can be used by service account.
743 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token of the authenticated user.
744 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
745 &quot;localId&quot;: &quot;A String&quot;, # Privileged caller can create user with specified user id.
746 &quot;password&quot;: &quot;A String&quot;, # The new password of the user.
747 &quot;phoneNumber&quot;: &quot;A String&quot;, # Privileged caller can create user with specified phone number.
748 &quot;photoUrl&quot;: &quot;A String&quot;, # The photo url of the user.
749 &quot;tenantId&quot;: &quot;A String&quot;, # For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
750 &quot;tenantProjectNumber&quot;: &quot;A String&quot;, # Tenant project number to be used for idp discovery.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800751 }
752
753
754Returns:
755 An object of the form:
756
757 { # Response of signing up new user, creating anonymous user or anonymous user reauth.
Bu Sun Kim65020912020-05-20 12:08:20 -0700758 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
759 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
760 &quot;expiresIn&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
761 &quot;idToken&quot;: &quot;A String&quot;, # The Gitkit id token to login the newly sign up user.
762 &quot;kind&quot;: &quot;identitytoolkit#SignupNewUserResponse&quot;, # The fixed string &quot;identitytoolkit#SignupNewUserResponse&quot;.
763 &quot;localId&quot;: &quot;A String&quot;, # The RP local ID of the user.
764 &quot;refreshToken&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be refresh token.
John Asmuth614db982014-04-24 15:46:26 -0400765 }</pre>
766</div>
767
768<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700769 <code class="details" id="uploadAccount">uploadAccount(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400770 <pre>Batch upload existing user accounts.
771
772Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700773 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400774 The object takes the form of:
775
776{ # Request to upload user account in batch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700777 &quot;allowOverwrite&quot;: True or False, # Whether allow overwrite existing account when user local_id exists.
778 &quot;blockSize&quot;: 42,
779 &quot;cpuMemCost&quot;: 42, # The following 4 fields are for standard scrypt algorithm.
780 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
781 &quot;dkLen&quot;: 42,
782 &quot;hashAlgorithm&quot;: &quot;A String&quot;, # The password hash algorithm.
783 &quot;memoryCost&quot;: 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
784 &quot;parallelization&quot;: 42,
785 &quot;rounds&quot;: 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.
786 &quot;saltSeparator&quot;: &quot;A String&quot;, # The salt separator.
787 &quot;sanityCheck&quot;: True or False, # If true, backend will do sanity check(including duplicate email and federated id) when uploading account.
788 &quot;signerKey&quot;: &quot;A String&quot;, # The key for to hash the password.
789 &quot;targetProjectId&quot;: &quot;A String&quot;, # Specify which project (field value is actually project id) to operate. Only used when provided credential.
790 &quot;users&quot;: [ # The account info to be stored.
John Asmuth614db982014-04-24 15:46:26 -0400791 { # Template for an individual account info.
Bu Sun Kim65020912020-05-20 12:08:20 -0700792 &quot;createdAt&quot;: &quot;A String&quot;, # User creation timestamp.
793 &quot;customAttributes&quot;: &quot;A String&quot;, # The custom attributes to be set in the user&#x27;s id token.
794 &quot;customAuth&quot;: True or False, # Whether the user is authenticated by the developer.
795 &quot;disabled&quot;: True or False, # Whether the user is disabled.
796 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
797 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
798 &quot;emailVerified&quot;: True or False, # Whether the email has been verified.
799 &quot;lastLoginAt&quot;: &quot;A String&quot;, # last login timestamp.
800 &quot;localId&quot;: &quot;A String&quot;, # The local ID of the user.
801 &quot;passwordHash&quot;: &quot;A String&quot;, # The user&#x27;s hashed password.
802 &quot;passwordUpdatedAt&quot;: 3.14, # The timestamp when the password was last updated.
803 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
804 &quot;photoUrl&quot;: &quot;A String&quot;, # The URL of the user profile photo.
805 &quot;providerUserInfo&quot;: [ # The IDP of the user.
John Asmuth614db982014-04-24 15:46:26 -0400806 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700807 &quot;displayName&quot;: &quot;A String&quot;, # The user&#x27;s display name at the IDP.
808 &quot;email&quot;: &quot;A String&quot;, # User&#x27;s email at IDP.
809 &quot;federatedId&quot;: &quot;A String&quot;, # User&#x27;s identifier at IDP.
810 &quot;phoneNumber&quot;: &quot;A String&quot;, # User&#x27;s phone number.
811 &quot;photoUrl&quot;: &quot;A String&quot;, # The user&#x27;s photo url at the IDP.
812 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For white listed IdPs it&#x27;s a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it&#x27;s the OP identifier.
813 &quot;rawId&quot;: &quot;A String&quot;, # User&#x27;s raw identifier directly returned from IDP.
814 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400815 },
816 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700817 &quot;rawPassword&quot;: &quot;A String&quot;, # The user&#x27;s plain text password.
818 &quot;salt&quot;: &quot;A String&quot;, # The user&#x27;s password salt.
819 &quot;screenName&quot;: &quot;A String&quot;, # User&#x27;s screen name at Twitter or login name at Github.
820 &quot;validSince&quot;: &quot;A String&quot;, # Timestamp in seconds for valid login token.
821 &quot;version&quot;: 42, # Version of the user&#x27;s password.
John Asmuth614db982014-04-24 15:46:26 -0400822 },
823 ],
John Asmuth614db982014-04-24 15:46:26 -0400824 }
825
826
827Returns:
828 An object of the form:
829
830 { # Respone of uploading accounts in batch.
Bu Sun Kim65020912020-05-20 12:08:20 -0700831 &quot;error&quot;: [ # The error encountered while processing the account info.
John Asmuth614db982014-04-24 15:46:26 -0400832 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700833 &quot;index&quot;: 42, # The index of the malformed account, starting from 0.
834 &quot;message&quot;: &quot;A String&quot;, # Detailed error message for the account info.
John Asmuth614db982014-04-24 15:46:26 -0400835 },
836 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700837 &quot;kind&quot;: &quot;identitytoolkit#UploadAccountResponse&quot;, # The fixed string &quot;identitytoolkit#UploadAccountResponse&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400838 }</pre>
839</div>
840
841<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700842 <code class="details" id="verifyAssertion">verifyAssertion(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400843 <pre>Verifies the assertion returned by the IdP.
844
845Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700846 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400847 The object takes the form of:
848
849{ # Request to verify the IDP assertion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700850 &quot;autoCreate&quot;: True or False, # When it&#x27;s true, automatically creates a new account if the user doesn&#x27;t exist. When it&#x27;s false, allows existing user to sign in normally and throws exception if the user doesn&#x27;t exist.
851 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
852 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token of the authenticated user.
853 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
854 &quot;pendingIdToken&quot;: &quot;A String&quot;, # The GITKit token for the non-trusted IDP pending to be confirmed by the user.
855 &quot;postBody&quot;: &quot;A String&quot;, # The post body if the request is a HTTP POST.
856 &quot;requestUri&quot;: &quot;A String&quot;, # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
857 &quot;returnIdpCredential&quot;: True or False, # Whether return 200 and IDP credential rather than throw exception when federated id is already linked.
858 &quot;returnRefreshToken&quot;: True or False, # Whether to return refresh tokens.
859 &quot;returnSecureToken&quot;: True or False, # Whether return sts id token and refresh token instead of gitkit token.
860 &quot;sessionId&quot;: &quot;A String&quot;, # Session ID, which should match the one in previous createAuthUri request.
861 &quot;tenantId&quot;: &quot;A String&quot;, # For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
862 &quot;tenantProjectNumber&quot;: &quot;A String&quot;, # Tenant project number to be used for idp discovery.
John Asmuth614db982014-04-24 15:46:26 -0400863 }
864
865
866Returns:
867 An object of the form:
868
869 { # Response of verifying the IDP assertion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700870 &quot;action&quot;: &quot;A String&quot;, # The action code.
871 &quot;appInstallationUrl&quot;: &quot;A String&quot;, # URL for OTA app installation.
872 &quot;appScheme&quot;: &quot;A String&quot;, # The custom scheme used by mobile app.
873 &quot;context&quot;: &quot;A String&quot;, # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
874 &quot;dateOfBirth&quot;: &quot;A String&quot;, # The birth date of the IdP account.
875 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the user.
876 &quot;email&quot;: &quot;A String&quot;, # The email returned by the IdP. NOTE: The federated login user may not own the email.
877 &quot;emailRecycled&quot;: True or False, # It&#x27;s true if the email is recycled.
878 &quot;emailVerified&quot;: True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.
879 &quot;errorMessage&quot;: &quot;A String&quot;, # Client error code.
880 &quot;expiresIn&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
881 &quot;federatedId&quot;: &quot;A String&quot;, # The unique ID identifies the IdP account.
882 &quot;firstName&quot;: &quot;A String&quot;, # The first name of the user.
883 &quot;fullName&quot;: &quot;A String&quot;, # The full name of the user.
884 &quot;idToken&quot;: &quot;A String&quot;, # The ID token.
885 &quot;inputEmail&quot;: &quot;A String&quot;, # It&#x27;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.
886 &quot;isNewUser&quot;: True or False, # True if it&#x27;s a new user sign-in, false if it&#x27;s a returning user.
887 &quot;kind&quot;: &quot;identitytoolkit#VerifyAssertionResponse&quot;, # The fixed string &quot;identitytoolkit#VerifyAssertionResponse&quot;.
888 &quot;language&quot;: &quot;A String&quot;, # The language preference of the user.
889 &quot;lastName&quot;: &quot;A String&quot;, # The last name of the user.
890 &quot;localId&quot;: &quot;A String&quot;, # The RP local ID if it&#x27;s already been mapped to the IdP account identified by the federated ID.
891 &quot;needConfirmation&quot;: True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.
892 &quot;needEmail&quot;: True or False, # Whether need client to supply email to complete the federated login flow.
893 &quot;nickName&quot;: &quot;A String&quot;, # The nick name of the user.
894 &quot;oauthAccessToken&quot;: &quot;A String&quot;, # The OAuth2 access token.
895 &quot;oauthAuthorizationCode&quot;: &quot;A String&quot;, # The OAuth2 authorization code.
896 &quot;oauthExpireIn&quot;: 42, # The lifetime in seconds of the OAuth2 access token.
897 &quot;oauthIdToken&quot;: &quot;A String&quot;, # The OIDC id token.
898 &quot;oauthRequestToken&quot;: &quot;A String&quot;, # The user approved request token for the OpenID OAuth extension.
899 &quot;oauthScope&quot;: &quot;A String&quot;, # The scope for the OpenID OAuth extension.
900 &quot;oauthTokenSecret&quot;: &quot;A String&quot;, # The OAuth1 access token secret.
901 &quot;originalEmail&quot;: &quot;A String&quot;, # The original email stored in the mapping storage. It&#x27;s returned when the federated ID is associated to a different email.
902 &quot;photoUrl&quot;: &quot;A String&quot;, # The URI of the public accessible profiel picture.
903 &quot;providerId&quot;: &quot;A String&quot;, # The IdP ID. For white listed IdPs it&#x27;s a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the &quot;providerId&quot; param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the &quot;identifier&quot; param is federated ID in the createAuthUri request. The domain part of the federated ID is returned.
904 &quot;rawUserInfo&quot;: &quot;A String&quot;, # Raw IDP-returned user info.
905 &quot;refreshToken&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be refresh token.
906 &quot;screenName&quot;: &quot;A String&quot;, # The screen_name of a Twitter user or the login name at Github.
907 &quot;timeZone&quot;: &quot;A String&quot;, # The timezone of the user.
908 &quot;verifiedProvider&quot;: [ # When action is &#x27;map&#x27;, contains the idps which can be used for confirmation.
909 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400910 ],
John Asmuth614db982014-04-24 15:46:26 -0400911 }</pre>
912</div>
913
914<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700915 <code class="details" id="verifyCustomToken">verifyCustomToken(body=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800916 <pre>Verifies the developer asserted ID token.
917
918Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700919 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800920 The object takes the form of:
921
922{ # Request to verify a custom token
Bu Sun Kim65020912020-05-20 12:08:20 -0700923 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
924 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
925 &quot;returnSecureToken&quot;: True or False, # Whether return sts id token and refresh token instead of gitkit token.
926 &quot;token&quot;: &quot;A String&quot;, # The custom token to verify
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800927 }
928
929
930Returns:
931 An object of the form:
932
933 { # Response from verifying a custom token
Bu Sun Kim65020912020-05-20 12:08:20 -0700934 &quot;expiresIn&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
935 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token for authenticated user.
936 &quot;isNewUser&quot;: True or False, # True if it&#x27;s a new user sign-in, false if it&#x27;s a returning user.
937 &quot;kind&quot;: &quot;identitytoolkit#VerifyCustomTokenResponse&quot;, # The fixed string &quot;identitytoolkit#VerifyCustomTokenResponse&quot;.
938 &quot;refreshToken&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be refresh token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800939 }</pre>
940</div>
941
942<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700943 <code class="details" id="verifyPassword">verifyPassword(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400944 <pre>Verifies the user entered password.
945
946Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700947 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400948 The object takes the form of:
949
950{ # Request to verify the password.
Bu Sun Kim65020912020-05-20 12:08:20 -0700951 &quot;captchaChallenge&quot;: &quot;A String&quot;, # The captcha challenge.
952 &quot;captchaResponse&quot;: &quot;A String&quot;, # Response to the captcha.
953 &quot;delegatedProjectNumber&quot;: &quot;A String&quot;, # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
954 &quot;email&quot;: &quot;A String&quot;, # The email of the user.
955 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token of the authenticated user.
956 &quot;instanceId&quot;: &quot;A String&quot;, # Instance id token of the app.
957 &quot;password&quot;: &quot;A String&quot;, # The password inputed by the user.
958 &quot;pendingIdToken&quot;: &quot;A String&quot;, # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.
959 &quot;returnSecureToken&quot;: True or False, # Whether return sts id token and refresh token instead of gitkit token.
960 &quot;tenantId&quot;: &quot;A String&quot;, # For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
961 &quot;tenantProjectNumber&quot;: &quot;A String&quot;, # Tenant project number to be used for idp discovery.
John Asmuth614db982014-04-24 15:46:26 -0400962 }
963
964
965Returns:
966 An object of the form:
967
968 { # Request of verifying the password.
Bu Sun Kim65020912020-05-20 12:08:20 -0700969 &quot;displayName&quot;: &quot;A String&quot;, # The name of the user.
970 &quot;email&quot;: &quot;A String&quot;, # The email returned by the IdP. NOTE: The federated login user may not own the email.
971 &quot;expiresIn&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
972 &quot;idToken&quot;: &quot;A String&quot;, # The GITKit token for authenticated user.
973 &quot;kind&quot;: &quot;identitytoolkit#VerifyPasswordResponse&quot;, # The fixed string &quot;identitytoolkit#VerifyPasswordResponse&quot;.
974 &quot;localId&quot;: &quot;A String&quot;, # The RP local ID if it&#x27;s already been mapped to the IdP account identified by the federated ID.
975 &quot;oauthAccessToken&quot;: &quot;A String&quot;, # The OAuth2 access token.
976 &quot;oauthAuthorizationCode&quot;: &quot;A String&quot;, # The OAuth2 authorization code.
977 &quot;oauthExpireIn&quot;: 42, # The lifetime in seconds of the OAuth2 access token.
978 &quot;photoUrl&quot;: &quot;A String&quot;, # The URI of the user&#x27;s photo at IdP
979 &quot;refreshToken&quot;: &quot;A String&quot;, # If idToken is STS id token, then this field will be refresh token.
980 &quot;registered&quot;: True or False, # Whether the email is registered.
John Asmuth614db982014-04-24 15:46:26 -0400981 }</pre>
982</div>
983
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700984<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700985 <code class="details" id="verifyPhoneNumber">verifyPhoneNumber(body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700986 <pre>Verifies ownership of a phone number and creates/updates the user account accordingly.
987
988Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700989 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700990 The object takes the form of:
991
992{ # Request for Identitytoolkit-VerifyPhoneNumber
Bu Sun Kim65020912020-05-20 12:08:20 -0700993 &quot;code&quot;: &quot;A String&quot;,
994 &quot;idToken&quot;: &quot;A String&quot;,
995 &quot;operation&quot;: &quot;A String&quot;,
996 &quot;phoneNumber&quot;: &quot;A String&quot;,
997 &quot;sessionInfo&quot;: &quot;A String&quot;, # The session info previously returned by IdentityToolkit-SendVerificationCode.
998 &quot;temporaryProof&quot;: &quot;A String&quot;,
999 &quot;verificationProof&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001000 }
1001
1002
1003Returns:
1004 An object of the form:
1005
1006 { # Response for Identitytoolkit-VerifyPhoneNumber
Bu Sun Kim65020912020-05-20 12:08:20 -07001007 &quot;expiresIn&quot;: &quot;A String&quot;,
1008 &quot;idToken&quot;: &quot;A String&quot;,
1009 &quot;isNewUser&quot;: True or False,
1010 &quot;localId&quot;: &quot;A String&quot;,
1011 &quot;phoneNumber&quot;: &quot;A String&quot;,
1012 &quot;refreshToken&quot;: &quot;A String&quot;,
1013 &quot;temporaryProof&quot;: &quot;A String&quot;,
1014 &quot;temporaryProofExpiresIn&quot;: &quot;A String&quot;,
1015 &quot;verificationProof&quot;: &quot;A String&quot;,
1016 &quot;verificationProofExpiresIn&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001017 }</pre>
1018</div>
1019
John Asmuth614db982014-04-24 15:46:26 -04001020</body></html>