Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / identitytoolkit_v3.relyingparty.html
blob: feb286ec2bf7e0338fa6fff7a9cc093ca70d3c1a [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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87 <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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#emailLinkSignin">emailLinkSignin(body)</a></code></p>
91<p class="firstline">Reset password for a user.</p>
92<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93 <code><a href="#getAccountInfo">getAccountInfo(body)</a></code></p>
94<p class="firstline">Returns the account info.</p>
95<p class="toc_element">
96 <code><a href="#getOobConfirmationCode">getOobConfirmationCode(body)</a></code></p>
97<p class="firstline">Get a code for user action confirmation.</p>
98<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]99 <code><a href="#getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]100<p class="firstline">Get project configuration.</p>
101<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 <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 +0000[diff] [blame]105 <code><a href="#getRecaptchaParam">getRecaptchaParam()</a></code></p>
106<p class="firstline">Get recaptcha secure param.</p>
107<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 <code><a href="#resetPassword">resetPassword(body)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]109<p class="firstline">Reset password for a user.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 <code><a href="#sendVerificationCode">sendVerificationCode(body)</a></code></p>
112<p class="firstline">Send SMS verification code.</p>
113<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 <code><a href="#setAccountInfo">setAccountInfo(body)</a></code></p>
115<p class="firstline">Set account info for a user.</p>
116<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]117 <code><a href="#setProjectConfig">setProjectConfig(body)</a></code></p>
118<p class="firstline">Set project configuration.</p>
119<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]120 <code><a href="#signOutUser">signOutUser(body)</a></code></p>
121<p class="firstline">Sign out user.</p>
122<p class="toc_element">
123 <code><a href="#signupNewUser">signupNewUser(body)</a></code></p>
124<p class="firstline">Signup new user.</p>
125<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 <code><a href="#uploadAccount">uploadAccount(body)</a></code></p>
127<p class="firstline">Batch upload existing user accounts.</p>
128<p class="toc_element">
129 <code><a href="#verifyAssertion">verifyAssertion(body)</a></code></p>
130<p class="firstline">Verifies the assertion returned by the IdP.</p>
131<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]132 <code><a href="#verifyCustomToken">verifyCustomToken(body)</a></code></p>
133<p class="firstline">Verifies the developer asserted ID token.</p>
134<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]135 <code><a href="#verifyPassword">verifyPassword(body)</a></code></p>
136<p class="firstline">Verifies the user entered password.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137<p class="toc_element">
138 <code><a href="#verifyPhoneNumber">verifyPhoneNumber(body)</a></code></p>
139<p class="firstline">Verifies ownership of a phone number and creates/updates the user account accordingly.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140<h3>Method Details</h3>
141<div class="method">
142 <code class="details" id="createAuthUri">createAuthUri(body)</code>
143 <pre>Creates the URI used by the IdP to authenticate the user.
144
145Args:
146 body: object, The request body. (required)
147 The object takes the form of:
148
149{ # Request to get the IDP authentication URL.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]150 "sessionId": "A String", # The session_id passed by client.
151 "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]152 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 "tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]154 "oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]155 "clientId": "A String", # The relying party OAuth client ID.
156 "oauthScope": "A String", # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
157 "otaApp": "A String", # The native app package for OTA installation.
158 "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]159 "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.
160 "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
161 "appId": "A String", # The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
162 "continueUri": "A String", # The URI to which the IDP redirects the user after the federated login flow.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]163 "customParameter": { # 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]164 "a_key": "A String", # The customized query parameter.
165 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]166 "identifier": "A String", # The email or federated ID of the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 "tenantId": "A String", # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 }
169
170
171Returns:
172 An object of the form:
173
174 { # Response of creating the IDP authentication URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]175 "sessionId": "A String", # Session ID which should be passed in the following verifyAssertion request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]177 "captchaRequired": True or False, # True if captcha is required.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178 "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]179 "allProviders": [ # all providers the user has once used to do federated login
180 "A String",
181 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 "forExistingProvider": True or False, # True if the authUri is for user's existing provider.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 "signinMethods": [ # All sign-in methods this user has used.
184 "A String",
185 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]186 "providerId": "A String", # The provider ID of the auth URI.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "authUri": "A String", # The URI used by the IDP to authenticate the user.
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="deleteAccount">deleteAccount(body)</code>
193 <pre>Delete user account.
194
195Args:
196 body: object, The request body. (required)
197 The object takes the form of:
198
199{ # Request to delete account.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]200 "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]201 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]202 "localId": "A String", # The local ID of the user.
203 }
204
205
206Returns:
207 An object of the form:
208
209 { # Respone of deleting account.
210 "kind": "identitytoolkit#DeleteAccountResponse", # The fixed string "identitytoolkit#DeleteAccountResponse".
211 }</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="downloadAccount">downloadAccount(body)</code>
216 <pre>Batch download user accounts.
217
218Args:
219 body: object, The request body. (required)
220 The object takes the form of:
221
222{ # Request to download user account in batch.
223 "nextPageToken": "A String", # The token for the next page. This should be taken from the previous response.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]224 "targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]225 "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]226 "maxResults": 42, # The max number of results to return in the response.
227 }
228
229
230Returns:
231 An object of the form:
232
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]233 { # Response of downloading accounts in batch.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 "nextPageToken": "A String", # The next page token. To be used in a subsequent request to return the next page of results.
235 "kind": "identitytoolkit#DownloadAccountResponse", # The fixed string "identitytoolkit#DownloadAccountResponse".
236 "users": [ # The user accounts data.
237 { # Template for an individual account info.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]238 "rawPassword": "A String", # The user's plain text password.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]239 "passwordHash": "A String", # The user's hashed password.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 "displayName": "A String", # The name of the user.
241 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]242 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 "photoUrl": "A String", # The URL of the user profile photo.
244 "emailVerified": True or False, # Whether the email has been verified.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]245 "lastLoginAt": "A String", # last login timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]246 "customAuth": True or False, # Whether the user is authenticated by the developer.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]247 "disabled": True or False, # Whether the user is disabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 "customAttributes": "A String", # The custom attributes to be set in the user's id token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 "version": 42, # Version of the user's password.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]250 "phoneNumber": "A String", # User's phone number.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]251 "providerUserInfo": [ # The IDP of the user.
252 {
253 "federatedId": "A String", # User's identifier at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]254 "displayName": "A String", # The user's display name at the IDP.
255 "photoUrl": "A String", # The user's photo url at the IDP.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]256 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]257 "phoneNumber": "A String", # User's phone number.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]258 "rawId": "A String", # User's raw identifier directly returned from IDP.
259 "email": "A String", # User's email at IDP.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]260 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 },
262 ],
263 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
264 "salt": "A String", # The user's password salt.
265 "email": "A String", # The email of the user.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]266 "createdAt": "A String", # User creation timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]267 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 },
269 ],
270 }</pre>
271</div>
272
273<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]274 <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:
282 A request object that you can call 'execute()' on to request the next
283 page. Returns None if there are no more items in the collection.
284 </pre>
285</div>
286
287<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 <code class="details" id="emailLinkSignin">emailLinkSignin(body)</code>
289 <pre>Reset password for a user.
290
291Args:
292 body: object, The request body. (required)
293 The object takes the form of:
294
295{ # Request to sign in with email.
296 "idToken": "A String", # Token for linking flow.
297 "oobCode": "A String", # The confirmation code.
298 "email": "A String", # The email address of the user.
299 }
300
301
302Returns:
303 An object of the form:
304
305 { # Response of email signIn.
306 "expiresIn": "A String", # Expiration time of STS id token in seconds.
307 "kind": "identitytoolkit#EmailLinkSigninResponse", # The fixed string "identitytoolkit#EmailLinkSigninResponse".
308 "refreshToken": "A String", # The refresh token for the signed in user.
309 "localId": "A String", # The RP local ID of the user.
310 "idToken": "A String", # The STS id token to login the newly signed in user.
311 "isNewUser": True or False, # Whether the user is new.
312 "email": "A String", # The user's email.
313 }</pre>
314</div>
315
316<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]317 <code class="details" id="getAccountInfo">getAccountInfo(body)</code>
318 <pre>Returns the account info.
319
320Args:
321 body: object, The request body. (required)
322 The object takes the form of:
323
324{ # Request to get the account information.
325 "idToken": "A String", # The GITKit token of the authenticated user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]326 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 "phoneNumber": [ # Privileged caller can query users by specified phone number.
328 "A String",
329 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]330 "email": [ # The list of emails of the users to inquiry.
331 "A String",
332 ],
333 "localId": [ # The list of local ID's of the users to inquiry.
334 "A String",
335 ],
336 }
337
338
339Returns:
340 An object of the form:
341
342 { # Response of getting account information.
343 "kind": "identitytoolkit#GetAccountInfoResponse", # The fixed string "identitytoolkit#GetAccountInfoResponse".
344 "users": [ # The info of the users.
345 { # Template for an individual account info.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]346 "rawPassword": "A String", # The user's plain text password.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]347 "passwordHash": "A String", # The user's hashed password.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]348 "displayName": "A String", # The name of the user.
349 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]350 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]351 "photoUrl": "A String", # The URL of the user profile photo.
352 "emailVerified": True or False, # Whether the email has been verified.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]353 "lastLoginAt": "A String", # last login timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]354 "customAuth": True or False, # Whether the user is authenticated by the developer.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]355 "disabled": True or False, # Whether the user is disabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 "customAttributes": "A String", # The custom attributes to be set in the user's id token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357 "version": 42, # Version of the user's password.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]358 "phoneNumber": "A String", # User's phone number.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359 "providerUserInfo": [ # The IDP of the user.
360 {
361 "federatedId": "A String", # User's identifier at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]362 "displayName": "A String", # The user's display name at the IDP.
363 "photoUrl": "A String", # The user's photo url at the IDP.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]364 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]365 "phoneNumber": "A String", # User's phone number.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]366 "rawId": "A String", # User's raw identifier directly returned from IDP.
367 "email": "A String", # User's email at IDP.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]368 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]369 },
370 ],
371 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
372 "salt": "A String", # The user's password salt.
373 "email": "A String", # The email of the user.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]374 "createdAt": "A String", # User creation timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]375 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]376 },
377 ],
378 }</pre>
379</div>
380
381<div class="method">
382 <code class="details" id="getOobConfirmationCode">getOobConfirmationCode(body)</code>
383 <pre>Get a code for user action confirmation.
384
385Args:
386 body: object, The request body. (required)
387 The object takes the form of:
388
389{ # Request of getting a code for user confirmation (reset password, change email etc.)
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]390 "canHandleCodeInApp": True or False, # whether or not the app can handle the oob code without first going to web
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]391 "kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]392 "iOSBundleId": "A String", # the iOS bundle id of iOS app to handle the action code
393 "androidMinimumVersion": "A String", # 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
394 "newEmail": "A String", # The new email if the code is for email change.
395 "androidPackageName": "A String", # android package name of the android app to handle the action code
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]396 "idToken": "A String", # The user's Gitkit login token for email change.
397 "challenge": "A String", # The recaptcha challenge presented to the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]398 "iOSAppStoreId": "A String", # iOS app store id to download the app if it's not already installed
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]399 "email": "A String", # The email of the user.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]400 "requestType": "A String", # The request type.
401 "androidInstallApp": True or False, # whether or not to install the android app on the device where the link is opened
402 "userIp": "A String", # The IP address of the user.
403 "continueUrl": "A String", # The url to continue to the Gitkit app
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]404 "captchaResp": "A String", # The recaptcha response from the user.
405 }
406
407
408Returns:
409 An object of the form:
410
411 { # Response of getting a code for user confirmation (reset password, change email etc.).
412 "kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".
413 "oobCode": "A String", # The code to be send to the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]414 "email": "A String", # The email address that the email is sent to.
415 }</pre>
416</div>
417
418<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]419 <code class="details" id="getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]420 <pre>Get project configuration.
421
422Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]423 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 -0800[diff] [blame]425
426Returns:
427 An object of the form:
428
429 { # Response of getting the project configuration.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]430 "dynamicLinksDomain": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]431 "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]432 "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
433 "projectId": "A String", # Project ID of the relying party.
434 "enableAnonymousUser": True or False, # Whether anonymous user is enabled.
435 "authorizedDomains": [ # Authorized domains.
436 "A String",
437 ],
438 "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
439 "body": "A String", # Email body.
440 "fromDisplayName": "A String", # From display name.
441 "from": "A String", # From address of the email.
442 "format": "A String", # Email body format.
443 "replyTo": "A String", # Reply-to address.
444 "subject": "A String", # Subject of the email.
445 },
446 "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
447 "body": "A String", # Email body.
448 "fromDisplayName": "A String", # From display name.
449 "from": "A String", # From address of the email.
450 "format": "A String", # Email body format.
451 "replyTo": "A String", # Reply-to address.
452 "subject": "A String", # Subject of the email.
453 },
454 "verifyEmailTemplate": { # Template for an email template. # Verify email template.
455 "body": "A String", # Email body.
456 "fromDisplayName": "A String", # From display name.
457 "from": "A String", # From address of the email.
458 "format": "A String", # Email body format.
459 "replyTo": "A String", # Reply-to address.
460 "subject": "A String", # Subject of the email.
461 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]462 "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]463 "changeEmailTemplate": { # Template for an email template. # Change email template.
464 "body": "A String", # Email body.
465 "fromDisplayName": "A String", # From display name.
466 "from": "A String", # From address of the email.
467 "format": "A String", # Email body format.
468 "replyTo": "A String", # Reply-to address.
469 "subject": "A String", # Subject of the email.
470 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471 "idpConfig": [ # OAuth2 provider configuration.
472 { # Template for a single idp configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]473 "whitelistedAudiences": [ # Whitelisted client IDs for audience check.
474 "A String",
475 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]476 "enabled": True or False, # Whether this IDP is enabled.
477 "clientId": "A String", # OAuth2 client ID.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]478 "secret": "A String", # OAuth2 client secret.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]479 "provider": "A String", # OAuth2 provider.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]480 "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]481 },
482 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]483 }</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.
496 "a_key": "A String",
497 }</pre>
498</div>
499
500<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]501 <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.
510 "kind": "identitytoolkit#GetRecaptchaParamResponse", # The fixed string "identitytoolkit#GetRecaptchaParamResponse".
511 "recaptchaSiteKey": "A String", # Site key registered at recaptcha.
512 "recaptchaStoken": "A String", # The stoken field for the recaptcha widget, used to request captcha challenge.
513 }</pre>
514</div>
515
516<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]517 <code class="details" id="resetPassword">resetPassword(body)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]518 <pre>Reset password for a user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]519
520Args:
521 body: object, The request body. (required)
522 The object takes the form of:
523
524{ # Request to reset the password.
525 "newPassword": "A String", # The new password inputted by the user.
526 "oldPassword": "A String", # The old password inputted by the user.
527 "oobCode": "A String", # The confirmation code.
528 "email": "A String", # The email address of the user.
529 }
530
531
532Returns:
533 An object of the form:
534
535 { # Response of resetting the password.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]536 "requestType": "A String", # The request type.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]537 "kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]538 "email": "A String", # The user's email. If the out-of-band code is for email recovery, the user's original email.
539 "newEmail": "A String", # If the out-of-band code is for email recovery, the user's new email.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]540 }</pre>
541</div>
542
543<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544 <code class="details" id="sendVerificationCode">sendVerificationCode(body)</code>
545 <pre>Send SMS verification code.
546
547Args:
548 body: object, The request body. (required)
549 The object takes the form of:
550
551{ # Request for Identitytoolkit-SendVerificationCode
552 "recaptchaToken": "A String", # Recaptcha solution.
553 "iosSecret": "A String", # Secret delivered to iOS app via APNS.
554 "iosReceipt": "A String", # Receipt of successful app token validation with APNS.
555 "phoneNumber": "A String", # The phone number to send the verification code to in E.164 format.
556 }
557
558
559Returns:
560 An object of the form:
561
562 { # Response for Identitytoolkit-SendVerificationCode
563 "sessionInfo": "A String", # Encrypted session information
564 }</pre>
565</div>
566
567<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]568 <code class="details" id="setAccountInfo">setAccountInfo(body)</code>
569 <pre>Set account info for a user.
570
571Args:
572 body: object, The request body. (required)
573 The object takes the form of:
574
575{ # Request to set the account information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]576 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]577 "validSince": "A String", # Timestamp in seconds for valid login token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]578 "photoUrl": "A String", # The photo url of the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]579 "instanceId": "A String", # Instance id token of the app.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]580 "lastLoginAt": "A String", # Last login timestamp.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 "disableUser": True or False, # Whether to disable the user.
582 "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
583 "createdAt": "A String", # The timestamp when the account is created.
584 "deleteAttribute": [ # The attributes users request to delete.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]585 "A String",
586 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]588 "deleteProvider": [ # The IDPs the user request to delete.
589 "A String",
590 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]591 "captchaChallenge": "A String", # The captcha challenge.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 "phoneNumber": "A String", # Privileged caller can update user with specified phone number.
593 "provider": [ # The associated IDPs of the user.
594 "A String",
595 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]596 "email": "A String", # The email of the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
598 "oobCode": "A String", # The out-of-band code of the change email request.
599 "captchaResponse": "A String", # Response to the captcha.
600 "password": "A String", # The new password of the user.
601 "displayName": "A String", # The name of the user.
602 "emailVerified": True or False, # Mark the email as verified or not.
603 "customAttributes": "A String", # The custom attributes to be set in the user's id token.
604 "idToken": "A String", # The GITKit token of the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]605 }
606
607
608Returns:
609 An object of the form:
610
611 { # Respone of setting the account information.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]612 "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]613 "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".
614 "displayName": "A String", # The name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]615 "localId": "A String", # The local ID of the user.
616 "photoUrl": "A String", # The photo url of the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]617 "emailVerified": True or False, # If email has been verified.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]618 "passwordHash": "A String", # The user's hashed password.
619 "newEmail": "A String", # The new email the user attempts to change to.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]620 "idToken": "A String", # The Gitkit id token to login the newly sign up user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]621 "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]622 "providerUserInfo": [ # The user's profiles at the associated IdPs.
623 {
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]624 "federatedId": "A String", # User's identifier at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]625 "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.
626 "displayName": "A String", # The user's display name at the IDP.
627 "photoUrl": "A String", # The user's photo url at the IDP.
628 },
629 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]630 "email": "A String", # The email of the user.
631 }</pre>
632</div>
633
634<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]635 <code class="details" id="setProjectConfig">setProjectConfig(body)</code>
636 <pre>Set project configuration.
637
638Args:
639 body: object, The request body. (required)
640 The object takes the form of:
641
642{ # Request to set the project configuration.
643 "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
644 "useEmailSending": True or False, # Whether to use email sending provided by Firebear.
645 "verifyEmailTemplate": { # Template for an email template. # Verify email template.
646 "body": "A String", # Email body.
647 "fromDisplayName": "A String", # From display name.
648 "from": "A String", # From address of the email.
649 "format": "A String", # Email body format.
650 "replyTo": "A String", # Reply-to address.
651 "subject": "A String", # Subject of the email.
652 },
653 "enableAnonymousUser": True or False, # Whether to enable anonymous user.
654 "authorizedDomains": [ # Authorized domains for widget redirect.
655 "A String",
656 ],
657 "resetPasswordTemplate": { # Template for an email template. # Reset password email template.
658 "body": "A String", # Email body.
659 "fromDisplayName": "A String", # From display name.
660 "from": "A String", # From address of the email.
661 "format": "A String", # Email body format.
662 "replyTo": "A String", # Reply-to address.
663 "subject": "A String", # Subject of the email.
664 },
665 "legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.
666 "body": "A String", # Email body.
667 "fromDisplayName": "A String", # From display name.
668 "from": "A String", # From address of the email.
669 "format": "A String", # Email body format.
670 "replyTo": "A String", # Reply-to address.
671 "subject": "A String", # Subject of the email.
672 },
673 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
674 "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
675 "changeEmailTemplate": { # Template for an email template. # Change email template.
676 "body": "A String", # Email body.
677 "fromDisplayName": "A String", # From display name.
678 "from": "A String", # From address of the email.
679 "format": "A String", # Email body format.
680 "replyTo": "A String", # Reply-to address.
681 "subject": "A String", # Subject of the email.
682 },
683 "idpConfig": [ # Oauth2 provider configuration.
684 { # Template for a single idp configuration.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]685 "whitelistedAudiences": [ # Whitelisted client IDs for audience check.
686 "A String",
687 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]688 "enabled": True or False, # Whether this IDP is enabled.
689 "clientId": "A String", # OAuth2 client ID.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]690 "secret": "A String", # OAuth2 client secret.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]691 "provider": "A String", # OAuth2 provider.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]692 "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]693 },
694 ],
695 }
696
697
698Returns:
699 An object of the form:
700
701 { # Response of setting the project configuration.
702 "projectId": "A String", # Project ID of the relying party.
703 }</pre>
704</div>
705
706<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]707 <code class="details" id="signOutUser">signOutUser(body)</code>
708 <pre>Sign out user.
709
710Args:
711 body: object, The request body. (required)
712 The object takes the form of:
713
714{ # Request to sign out user.
715 "instanceId": "A String", # Instance id token of the app.
716 "localId": "A String", # The local ID of the user.
717 }
718
719
720Returns:
721 An object of the form:
722
723 { # Response of signing out user.
724 "localId": "A String", # The local ID of the user.
725 }</pre>
726</div>
727
728<div class="method">
729 <code class="details" id="signupNewUser">signupNewUser(body)</code>
730 <pre>Signup new user.
731
732Args:
733 body: object, The request body. (required)
734 The object takes the form of:
735
736{ # Request to signup new user, create anonymous user or anonymous user reauth.
737 "instanceId": "A String", # Instance id token of the app.
738 "displayName": "A String", # The name of the user.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]739 "localId": "A String", # Privileged caller can create user with specified user id.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]740 "photoUrl": "A String", # The photo url of the user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]741 "captchaResponse": "A String", # Response to the captcha.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]742 "emailVerified": True or False, # Mark the email as verified or not. Only can be used by service account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]743 "tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.
744 "tenantId": "A String", # 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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]745 "disabled": True or False, # Whether to disable the user. Only can be used by service account.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]746 "captchaChallenge": "A String", # The captcha challenge.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 "phoneNumber": "A String", # Privileged caller can create user with specified phone number.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]748 "idToken": "A String", # The GITKit token of the authenticated user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]749 "password": "A String", # The new password of the user.
750 "email": "A String", # The email of the user.
751 }
752
753
754Returns:
755 An object of the form:
756
757 { # Response of signing up new user, creating anonymous user or anonymous user reauth.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]758 "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]759 "kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".
760 "displayName": "A String", # The name of the user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]761 "localId": "A String", # The RP local ID of the user.
762 "idToken": "A String", # The Gitkit id token to login the newly sign up user.
763 "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]764 "email": "A String", # The email of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]765 }</pre>
766</div>
767
768<div class="method">
769 <code class="details" id="uploadAccount">uploadAccount(body)</code>
770 <pre>Batch upload existing user accounts.
771
772Args:
773 body: object, The request body. (required)
774 The object takes the form of:
775
776{ # Request to upload user account in batch.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]777 "dkLen": 42,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]778 "hashAlgorithm": "A String", # The password hash algorithm.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]779 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]780 "allowOverwrite": True or False, # Whether allow overwrite existing account when user local_id exists.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]781 "users": [ # The account info to be stored.
782 { # Template for an individual account info.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]783 "rawPassword": "A String", # The user's plain text password.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]784 "passwordHash": "A String", # The user's hashed password.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]785 "displayName": "A String", # The name of the user.
786 "localId": "A String", # The local ID of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]787 "validSince": "A String", # Timestamp in seconds for valid login token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]788 "photoUrl": "A String", # The URL of the user profile photo.
789 "emailVerified": True or False, # Whether the email has been verified.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]790 "lastLoginAt": "A String", # last login timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]791 "customAuth": True or False, # Whether the user is authenticated by the developer.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]792 "disabled": True or False, # Whether the user is disabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]793 "customAttributes": "A String", # The custom attributes to be set in the user's id token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]794 "version": 42, # Version of the user's password.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]795 "phoneNumber": "A String", # User's phone number.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]796 "providerUserInfo": [ # The IDP of the user.
797 {
798 "federatedId": "A String", # User's identifier at IDP.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]799 "displayName": "A String", # The user's display name at the IDP.
800 "photoUrl": "A String", # The user's photo url at the IDP.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]801 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]802 "phoneNumber": "A String", # User's phone number.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]803 "rawId": "A String", # User's raw identifier directly returned from IDP.
804 "email": "A String", # User's email at IDP.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]805 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]806 },
807 ],
808 "passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.
809 "salt": "A String", # The user's password salt.
810 "email": "A String", # The email of the user.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]811 "createdAt": "A String", # User creation timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]812 "screenName": "A String", # User's screen name at Twitter or login name at Github.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]813 },
814 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]815 "parallelization": 42,
816 "blockSize": 42,
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]817 "sanityCheck": True or False, # If true, backend will do sanity check(including duplicate email and federated id) when uploading account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]818 "cpuMemCost": 42, # The following 4 fields are for standard scrypt algorithm.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]819 "signerKey": "A String", # The key for to hash the password.
820 "memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.
821 "saltSeparator": "A String", # The salt separator.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame]822 "targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]823 "rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]824 }
825
826
827Returns:
828 An object of the form:
829
830 { # Respone of uploading accounts in batch.
831 "kind": "identitytoolkit#UploadAccountResponse", # The fixed string "identitytoolkit#UploadAccountResponse".
832 "error": [ # The error encountered while processing the account info.
833 {
834 "index": 42, # The index of the malformed account, starting from 0.
835 "message": "A String", # Detailed error message for the account info.
836 },
837 ],
838 }</pre>
839</div>
840
841<div class="method">
842 <code class="details" id="verifyAssertion">verifyAssertion(body)</code>
843 <pre>Verifies the assertion returned by the IdP.
844
845Args:
846 body: object, The request body. (required)
847 The object takes the form of:
848
849{ # Request to verify the IDP assertion.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]850 "postBody": "A String", # The post body if the request is a HTTP POST.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]851 "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.
852 "instanceId": "A String", # Instance id token of the app.
853 "idToken": "A String", # The GITKit token of the authenticated user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]854 "tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]855 "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]856 "sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]857 "tenantId": "A String", # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]858 "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]859 "returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]860 "autoCreate": True or False, # When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]861 "returnRefreshToken": True or False, # Whether to return refresh tokens.
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]862 "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]863 }
864
865
866Returns:
867 An object of the form:
868
869 { # Response of verifying the IDP assertion.
870 "federatedId": "A String", # The unique ID identifies the IdP account.
871 "localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
872 "photoUrl": "A String", # The URI of the public accessible profiel picture.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]873 "isNewUser": True or False, # True if it's a new user sign-in, false if it's a returning user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]874 "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]875 "rawUserInfo": "A String", # Raw IDP-returned user info.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]876 "appScheme": "A String", # The custom scheme used by mobile app.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]877 "expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
878 "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]879 "verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.
880 "A String",
881 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]882 "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]883 "dateOfBirth": "A String", # The birth date of the IdP account.
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]884 "oauthAccessToken": "A String", # The OAuth2 access token.
885 "emailRecycled": True or False, # It's true if the email is recycled.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]886 "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]887 "screenName": "A String", # The screen_name of a Twitter user or the login name at Github.
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]888 "nickName": "A String", # The nick name of the user.
889 "errorMessage": "A String", # Client error code.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]890 "oauthTokenSecret": "A String", # The OAuth1 access token secret.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]891 "language": "A String", # The language preference of the user.
892 "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]893 "oauthIdToken": "A String", # The OIDC id token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]894 "fullName": "A String", # The full name of the user.
895 "kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]896 "displayName": "A String", # The display name of the user.
897 "appInstallationUrl": "A String", # URL for OTA app installation.
898 "firstName": "A String", # The first name of the user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]899 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]900 "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]901 "lastName": "A String", # The last name of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]902 "oauthScope": "A String", # The scope for the OpenID OAuth extension.
903 "oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]904 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]905 "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]906 "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]907 "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]908 "idToken": "A String", # The ID token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]909 "action": "A String", # The action code.
910 "timeZone": "A String", # The timezone of the user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]911 }</pre>
912</div>
913
914<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]915 <code class="details" id="verifyCustomToken">verifyCustomToken(body)</code>
916 <pre>Verifies the developer asserted ID token.
917
918Args:
919 body: object, The request body. (required)
920 The object takes the form of:
921
922{ # Request to verify a custom token
923 "instanceId": "A String", # Instance id token of the app.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]924 "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]925 "token": "A String", # The custom token to verify
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]926 "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]927 }
928
929
930Returns:
931 An object of the form:
932
933 { # Response from verifying a custom token
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]934 "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]935 "idToken": "A String", # The GITKit token for authenticated user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936 "isNewUser": True or False, # True if it's a new user sign-in, false if it's a returning user.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]937 "refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]938 "kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]939 }</pre>
940</div>
941
942<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]943 <code class="details" id="verifyPassword">verifyPassword(body)</code>
944 <pre>Verifies the user entered password.
945
946Args:
947 body: object, The request body. (required)
948 The object takes the form of:
949
950{ # Request to verify the password.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]951 "instanceId": "A String", # Instance id token of the app.
952 "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]953 "captchaResponse": "A String", # Response to the captcha.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]954 "idToken": "A String", # The GITKit token of the authenticated user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]955 "tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]956 "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]957 "captchaChallenge": "A String", # The captcha challenge.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]958 "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]959 "password": "A String", # The password inputed by the user.
960 "email": "A String", # The email of the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]961 "tenantId": "A String", # 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]962 }
963
964
965Returns:
966 An object of the form:
967
968 { # Request of verifying the password.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]969 "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]970 "kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".
971 "displayName": "A String", # The name of the user.
972 "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]973 "oauthAccessToken": "A String", # The OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]974 "photoUrl": "A String", # The URI of the user's photo at IdP
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]975 "oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]976 "idToken": "A String", # The GITKit token for authenticated user.
977 "registered": True or False, # Whether the email is registered.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]978 "oauthAuthorizationCode": "A String", # The OAuth2 authorization code.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]979 "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]980 "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.
981 }</pre>
982</div>
983
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]984<div class="method">
985 <code class="details" id="verifyPhoneNumber">verifyPhoneNumber(body)</code>
986 <pre>Verifies ownership of a phone number and creates/updates the user account accordingly.
987
988Args:
989 body: object, The request body. (required)
990 The object takes the form of:
991
992{ # Request for Identitytoolkit-VerifyPhoneNumber
993 "verificationProof": "A String",
994 "code": "A String",
995 "sessionInfo": "A String", # The session info previously returned by IdentityToolkit-SendVerificationCode.
996 "idToken": "A String",
997 "phoneNumber": "A String",
998 "operation": "A String",
999 "temporaryProof": "A String",
1000 }
1001
1002
1003Returns:
1004 An object of the form:
1005
1006 { # Response for Identitytoolkit-VerifyPhoneNumber
1007 "expiresIn": "A String",
1008 "temporaryProofExpiresIn": "A String",
1009 "refreshToken": "A String",
1010 "localId": "A String",
1011 "verificationProofExpiresIn": "A String",
1012 "idToken": "A String",
1013 "isNewUser": True or False,
1014 "verificationProof": "A String",
1015 "phoneNumber": "A String",
1016 "temporaryProof": "A String",
1017 }</pre>
1018</div>
1019
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1020</body></html>