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