Blame - docs/dyn/identitytoolkit_v3.relyingparty.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

158

"hostedDomain": "A String", # The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.

159

"identifier": "A String", # The email or federated ID of the user.

160

"oauthConsumerKey": "A String", # The developer's consumer key for OpenId OAuth Extension

161

"oauthScope": "A String", # Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant

162

"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.

163

"otaApp": "A String", # The native app package for OTA installation.

164

"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.

165

"sessionId": "A String", # The session_id passed by client.

166

"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.

167

"tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

173

174

{ # Response of creating the IDP authentication URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

"allProviders": [ # all providers the user has once used to do federated login

176

"A String",

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

177

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

178

"authUri": "A String", # The URI used by the IDP to authenticate the user.

179

"captchaRequired": True or False, # True if captcha is required.

180

"forExistingProvider": True or False, # True if the authUri is for user's existing provider.

181

"kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse".

182

"providerId": "A String", # The provider ID of the auth URI.

183

"registered": True or False, # Whether the user is registered if the identifier is an email.

184

"sessionId": "A String", # Session ID which should be passed in the following verifyAssertion request.

185

"signinMethods": [ # All sign-in methods this user has used.

186

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

187

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

192

<code class="details" id="deleteAccount">deleteAccount(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

193

<pre>Delete user account.

194

195

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

196

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

197

The object takes the form of:

198

199

{ # Request to delete account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

201

"idToken": "A String", # The GITKit token or STS id token of the authenticated user.

202

"localId": "A String", # The local ID of the user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

208

209

{ # Respone of deleting account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

210

"kind": "identitytoolkit#DeleteAccountResponse", # The fixed string "identitytoolkit#DeleteAccountResponse".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

215

<code class="details" id="downloadAccount">downloadAccount(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

216

<pre>Batch download user accounts.

217

218

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

219

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

220

The object takes the form of:

221

222

{ # Request to download user account in batch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

223

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

224

"maxResults": 42, # The max number of results to return in the response.

225

"nextPageToken": "A String", # The token for the next page. This should be taken from the previous response.

226

"targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

232

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

233

{ # Response of downloading accounts in batch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

234

"kind": "identitytoolkit#DownloadAccountResponse", # The fixed string "identitytoolkit#DownloadAccountResponse".

235

"nextPageToken": "A String", # The next page token. To be used in a subsequent request to return the next page of results.

236

"users": [ # The user accounts data.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

237

{ # Template for an individual account info.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

238

"createdAt": "A String", # User creation timestamp.

239

"customAttributes": "A String", # The custom attributes to be set in the user's id token.

240

"customAuth": True or False, # Whether the user is authenticated by the developer.

241

"disabled": True or False, # Whether the user is disabled.

242

"displayName": "A String", # The name of the user.

243

"email": "A String", # The email of the user.

244

"emailVerified": True or False, # Whether the email has been verified.

245

"lastLoginAt": "A String", # last login timestamp.

246

"localId": "A String", # The local ID of the user.

247

"passwordHash": "A String", # The user's hashed password.

248

"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.

249

"phoneNumber": "A String", # User's phone number.

250

"photoUrl": "A String", # The URL of the user profile photo.

251

"providerUserInfo": [ # The IDP of the user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

252

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

"displayName": "A String", # The user's display name at the IDP.

254

"email": "A String", # User's email at IDP.

255

"federatedId": "A String", # User's identifier at IDP.

256

"phoneNumber": "A String", # User's phone number.

257

"photoUrl": "A String", # The user's photo url at the IDP.

258

"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.

259

"rawId": "A String", # User's raw identifier directly returned from IDP.

260

"screenName": "A String", # User's screen name at Twitter or login name at Github.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

261

},

262

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

263

"rawPassword": "A String", # The user's plain text password.

264

"salt": "A String", # The user's password salt.

265

"screenName": "A String", # User's screen name at Twitter or login name at Github.

266

"validSince": "A String", # Timestamp in seconds for valid login token.

267

"version": 42, # Version of the user's password.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}</pre>

</div>

Sai Cheemalapati

2017-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

277

Args:

278

previous_request: The request for the previous page. (required)

279

previous_response: The response from the request for the previous page. (required)

280

281

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

282

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

283

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

288

<code class="details" id="emailLinkSignin">emailLinkSignin(body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

289

<pre>Reset password for a user.

290

291

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

292

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

293

The object takes the form of:

294

295

{ # Request to sign in with email.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

"email": "A String", # The email address of the user.

297

"idToken": "A String", # Token for linking flow.

298

"oobCode": "A String", # The confirmation code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

304

305

{ # Response of email signIn.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

306

"email": "A String", # The user's email.

307

"expiresIn": "A String", # Expiration time of STS id token in seconds.

308

"idToken": "A String", # The STS id token to login the newly signed in user.

309

"isNewUser": True or False, # Whether the user is new.

310

"kind": "identitytoolkit#EmailLinkSigninResponse", # The fixed string "identitytoolkit#EmailLinkSigninResponse".

311

"localId": "A String", # The RP local ID of the user.

312

"refreshToken": "A String", # The refresh token for the signed in user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

317

<code class="details" id="getAccountInfo">getAccountInfo(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

318

<pre>Returns the account info.

319

320

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

321

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

322

The object takes the form of:

323

324

{ # Request to get the account information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

326

"email": [ # The list of emails of the users to inquiry.

327

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

328

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

329

"idToken": "A String", # The GITKit token of the authenticated user.

330

"localId": [ # The list of local ID's of the users to inquiry.

331

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

332

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

"phoneNumber": [ # Privileged caller can query users by specified phone number.

334

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

],

}

Returns:

An object of the form:

341

342

{ # Response of getting account information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

"kind": "identitytoolkit#GetAccountInfoResponse", # The fixed string "identitytoolkit#GetAccountInfoResponse".

344

"users": [ # The info of the users.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

345

{ # Template for an individual account info.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

346

"createdAt": "A String", # User creation timestamp.

347

"customAttributes": "A String", # The custom attributes to be set in the user's id token.

348

"customAuth": True or False, # Whether the user is authenticated by the developer.

349

"disabled": True or False, # Whether the user is disabled.

350

"displayName": "A String", # The name of the user.

351

"email": "A String", # The email of the user.

352

"emailVerified": True or False, # Whether the email has been verified.

353

"lastLoginAt": "A String", # last login timestamp.

354

"localId": "A String", # The local ID of the user.

355

"passwordHash": "A String", # The user's hashed password.

356

"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.

357

"phoneNumber": "A String", # User's phone number.

358

"photoUrl": "A String", # The URL of the user profile photo.

359

"providerUserInfo": [ # The IDP of the user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

360

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

361

"displayName": "A String", # The user's display name at the IDP.

362

"email": "A String", # User's email at IDP.

363

"federatedId": "A String", # User's identifier at IDP.

364

"phoneNumber": "A String", # User's phone number.

365

"photoUrl": "A String", # The user's photo url at the IDP.

366

"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.

367

"rawId": "A String", # User's raw identifier directly returned from IDP.

368

"screenName": "A String", # User's screen name at Twitter or login name at Github.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

369

},

370

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

371

"rawPassword": "A String", # The user's plain text password.

372

"salt": "A String", # The user's password salt.

373

"screenName": "A String", # User's screen name at Twitter or login name at Github.

374

"validSince": "A String", # Timestamp in seconds for valid login token.

375

"version": 42, # Version of the user's password.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

382

<code class="details" id="getOobConfirmationCode">getOobConfirmationCode(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

383

<pre>Get a code for user action confirmation.

384

385

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

386

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

387

The object takes the form of:

388

389

{ # Request of getting a code for user confirmation (reset password, change email etc.)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

390

"androidInstallApp": True or False, # whether or not to install the android app on the device where the link is opened

391

"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

392

"androidPackageName": "A String", # android package name of the android app to handle the action code

393

"canHandleCodeInApp": True or False, # whether or not the app can handle the oob code without first going to web

394

"captchaResp": "A String", # The recaptcha response from the user.

395

"challenge": "A String", # The recaptcha challenge presented to the user.

396

"continueUrl": "A String", # The url to continue to the Gitkit app

397

"email": "A String", # The email of the user.

398

"iOSAppStoreId": "A String", # iOS app store id to download the app if it's not already installed

399

"iOSBundleId": "A String", # the iOS bundle id of iOS app to handle the action code

400

"idToken": "A String", # The user's Gitkit login token for email change.

401

"kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".

402

"newEmail": "A String", # The new email if the code is for email change.

403

"requestType": "A String", # The request type.

404

"userIp": "A String", # The IP address of the user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

410

411

{ # Response of getting a code for user confirmation (reset password, change email etc.).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

412

"email": "A String", # The email address that the email is sent to.

413

"kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".

414

"oobCode": "A String", # The code to be send to the user.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

419

<code class="details" id="getProjectConfig">getProjectConfig(delegatedProjectNumber=None, projectNumber=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

420

<pre>Get project configuration.

421

422

Args:

Jon Wayne Parrott

2016-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 Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

425

426

Returns:

427

An object of the form:

428

429

{ # Response of getting the project configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

430

"allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.

431

"apiKey": "A String", # Browser API key, needed when making http request to Apiary.

432

"authorizedDomains": [ # Authorized domains.

433

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

434

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

435

"changeEmailTemplate": { # Template for an email template. # Change email template.

436

"body": "A String", # Email body.

437

"format": "A String", # Email body format.

438

"from": "A String", # From address of the email.

439

"fromDisplayName": "A String", # From display name.

440

"replyTo": "A String", # Reply-to address.

441

"subject": "A String", # Subject of the email.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"dynamicLinksDomain": "A String",

444

"enableAnonymousUser": True or False, # Whether anonymous user is enabled.

445

"idpConfig": [ # OAuth2 provider configuration.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

446

{ # Template for a single idp configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

447

"clientId": "A String", # OAuth2 client ID.

448

"enabled": True or False, # Whether this IDP is enabled.

449

"experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.

450

"provider": "A String", # OAuth2 provider.

451

"secret": "A String", # OAuth2 client secret.

452

"whitelistedAudiences": [ # Whitelisted client IDs for audience check.

453

"A String",

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

454

],

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

455

},

456

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

457

"legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.

458

"body": "A String", # Email body.

459

"format": "A String", # Email body format.

460

"from": "A String", # From address of the email.

461

"fromDisplayName": "A String", # From display name.

462

"replyTo": "A String", # Reply-to address.

463

"subject": "A String", # Subject of the email.

464

},

465

"projectId": "A String", # Project ID of the relying party.

466

"resetPasswordTemplate": { # Template for an email template. # Reset password email template.

467

"body": "A String", # Email body.

468

"format": "A String", # Email body format.

469

"from": "A String", # From address of the email.

470

"fromDisplayName": "A String", # From display name.

471

"replyTo": "A String", # Reply-to address.

472

"subject": "A String", # Subject of the email.

473

},

474

"useEmailSending": True or False, # Whether to use email sending provided by Firebear.

475

"verifyEmailTemplate": { # Template for an email template. # Verify email template.

476

"body": "A String", # Email body.

477

"format": "A String", # Email body format.

478

"from": "A String", # From address of the email.

479

"fromDisplayName": "A String", # From display name.

480

"replyTo": "A String", # Reply-to address.

481

"subject": "A String", # Subject of the email.

482

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="getPublicKeys">getPublicKeys()</code>

488

<pre>Get token signing public key.

Args:

Returns:

An object of the form:

494

495

{ # Respone of getting public keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

496

"a_key": "A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

501

<code class="details" id="getRecaptchaParam">getRecaptchaParam()</code>

502

<pre>Get recaptcha secure param.

Args:

Returns:

An object of the form:

508

509

{ # Response of getting recaptcha param.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

517

<code class="details" id="resetPassword">resetPassword(body=None)</code>

Craig Citro

0e5b9bf

2014-10-15 10:26:14 -0700

[diff] [blame]

518

<pre>Reset password for a user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

519

520

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

521

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

522

The object takes the form of:

523

524

{ # Request to reset the password.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

525

"email": "A String", # The email address of the user.

526

"newPassword": "A String", # The new password inputted by the user.

527

"oldPassword": "A String", # The old password inputted by the user.

528

"oobCode": "A String", # The confirmation code.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

534

535

{ # Response of resetting the password.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

536

"email": "A String", # The user's email. If the out-of-band code is for email recovery, the user's original email.

537

"kind": "identitytoolkit#ResetPasswordResponse", # The fixed string "identitytoolkit#ResetPasswordResponse".

538

"newEmail": "A String", # If the out-of-band code is for email recovery, the user's new email.

539

"requestType": "A String", # The request type.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

544

<code class="details" id="sendVerificationCode">sendVerificationCode(body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

545

<pre>Send SMS verification code.

546

547

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

548

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

549

The object takes the form of:

550

551

{ # Request for Identitytoolkit-SendVerificationCode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

552

"iosReceipt": "A String", # Receipt of successful app token validation with APNS.

553

"iosSecret": "A String", # Secret delivered to iOS app via APNS.

554

"phoneNumber": "A String", # The phone number to send the verification code to in E.164 format.

555

"recaptchaToken": "A String", # Recaptcha solution.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

561

562

{ # Response for Identitytoolkit-SendVerificationCode

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

563

"sessionInfo": "A String", # Encrypted session information

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

568

<code class="details" id="setAccountInfo">setAccountInfo(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

569

<pre>Set account info for a user.

570

571

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

572

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

573

The object takes the form of:

574

575

{ # Request to set the account information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

576

"captchaChallenge": "A String", # The captcha challenge.

577

"captchaResponse": "A String", # Response to the captcha.

578

"createdAt": "A String", # The timestamp when the account is created.

579

"customAttributes": "A String", # The custom attributes to be set in the user's id token.

580

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

581

"deleteAttribute": [ # The attributes users request to delete.

582

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

583

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

584

"deleteProvider": [ # The IDPs the user request to delete.

585

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

586

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

587

"disableUser": True or False, # Whether to disable the user.

588

"displayName": "A String", # The name of the user.

589

"email": "A String", # The email of the user.

590

"emailVerified": True or False, # Mark the email as verified or not.

591

"idToken": "A String", # The GITKit token of the authenticated user.

592

"instanceId": "A String", # Instance id token of the app.

593

"lastLoginAt": "A String", # Last login timestamp.

594

"localId": "A String", # The local ID of the user.

595

"oobCode": "A String", # The out-of-band code of the change email request.

596

"password": "A String", # The new password of the user.

597

"phoneNumber": "A String", # Privileged caller can update user with specified phone number.

598

"photoUrl": "A String", # The photo url of the user.

599

"provider": [ # The associated IDPs of the user.

600

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

601

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

602

"returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.

603

"upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login.

604

"validSince": "A String", # Timestamp in seconds for valid login token.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

610

611

{ # Respone of setting the account information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

612

"displayName": "A String", # The name of the user.

613

"email": "A String", # The email of the user.

614

"emailVerified": True or False, # If email has been verified.

615

"expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

616

"idToken": "A String", # The Gitkit id token to login the newly sign up user.

617

"kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse".

618

"localId": "A String", # The local ID of the user.

619

"newEmail": "A String", # The new email the user attempts to change to.

620

"passwordHash": "A String", # The user's hashed password.

621

"photoUrl": "A String", # The photo url of the user.

622

"providerUserInfo": [ # The user's profiles at the associated IdPs.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

623

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

624

"displayName": "A String", # The user's display name at the IDP.

625

"federatedId": "A String", # User's identifier at IDP.

626

"photoUrl": "A String", # The user's photo url at the IDP.

627

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

628

},

629

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

630

"refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

635

<code class="details" id="setProjectConfig">setProjectConfig(body=None)</code>

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

636

<pre>Set project configuration.

637

638

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

639

body: object, The request body.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

640

The object takes the form of:

641

642

{ # Request to set the project configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

643

"allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.

644

"apiKey": "A String", # Browser API key, needed when making http request to Apiary.

645

"authorizedDomains": [ # Authorized domains for widget redirect.

646

"A String",

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

647

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

648

"changeEmailTemplate": { # Template for an email template. # Change email template.

649

"body": "A String", # Email body.

650

"format": "A String", # Email body format.

651

"from": "A String", # From address of the email.

652

"fromDisplayName": "A String", # From display name.

653

"replyTo": "A String", # Reply-to address.

654

"subject": "A String", # Subject of the email.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

655

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

657

"enableAnonymousUser": True or False, # Whether to enable anonymous user.

658

"idpConfig": [ # Oauth2 provider configuration.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

659

{ # Template for a single idp configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

660

"clientId": "A String", # OAuth2 client ID.

661

"enabled": True or False, # Whether this IDP is enabled.

662

"experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.

663

"provider": "A String", # OAuth2 provider.

664

"secret": "A String", # OAuth2 client secret.

665

"whitelistedAudiences": [ # Whitelisted client IDs for audience check.

666

"A String",

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

667

],

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

668

},

669

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

670

"legacyResetPasswordTemplate": { # Template for an email template. # Legacy reset password email template.

671

"body": "A String", # Email body.

672

"format": "A String", # Email body format.

673

"from": "A String", # From address of the email.

674

"fromDisplayName": "A String", # From display name.

675

"replyTo": "A String", # Reply-to address.

676

"subject": "A String", # Subject of the email.

677

},

678

"resetPasswordTemplate": { # Template for an email template. # Reset password email template.

679

"body": "A String", # Email body.

680

"format": "A String", # Email body format.

681

"from": "A String", # From address of the email.

682

"fromDisplayName": "A String", # From display name.

683

"replyTo": "A String", # Reply-to address.

684

"subject": "A String", # Subject of the email.

685

},

686

"useEmailSending": True or False, # Whether to use email sending provided by Firebear.

687

"verifyEmailTemplate": { # Template for an email template. # Verify email template.

688

"body": "A String", # Email body.

689

"format": "A String", # Email body format.

690

"from": "A String", # From address of the email.

691

"fromDisplayName": "A String", # From display name.

692

"replyTo": "A String", # Reply-to address.

693

"subject": "A String", # Subject of the email.

694

},

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}

Returns:

An object of the form:

700

701

{ # Response of setting the project configuration.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

702

"projectId": "A String", # Project ID of the relying party.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

707

<code class="details" id="signOutUser">signOutUser(body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

708

<pre>Sign out user.

709

710

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

711

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

712

The object takes the form of:

713

714

{ # Request to sign out user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

715

"instanceId": "A String", # Instance id token of the app.

716

"localId": "A String", # The local ID of the user.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}

Returns:

An object of the form:

722

723

{ # Response of signing out user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

724

"localId": "A String", # The local ID of the user.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

729

<code class="details" id="signupNewUser">signupNewUser(body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

730

<pre>Signup new user.

731

732

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

733

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

734

The object takes the form of:

735

736

{ # Request to signup new user, create anonymous user or anonymous user reauth.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

737

"captchaChallenge": "A String", # The captcha challenge.

738

"captchaResponse": "A String", # Response to the captcha.

739

"disabled": True or False, # Whether to disable the user. Only can be used by service account.

740

"displayName": "A String", # The name of the user.

741

"email": "A String", # The email of the user.

742

"emailVerified": True or False, # Mark the email as verified or not. Only can be used by service account.

743

"idToken": "A String", # The GITKit token of the authenticated user.

744

"instanceId": "A String", # Instance id token of the app.

745

"localId": "A String", # Privileged caller can create user with specified user id.

746

"password": "A String", # The new password of the user.

747

"phoneNumber": "A String", # Privileged caller can create user with specified phone number.

748

"photoUrl": "A String", # The photo url of the user.

749

"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.

750

"tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}

Returns:

An object of the form:

756

757

{ # Response of signing up new user, creating anonymous user or anonymous user reauth.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

758

"displayName": "A String", # The name of the user.

759

"email": "A String", # The email of the user.

760

"expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

761

"idToken": "A String", # The Gitkit id token to login the newly sign up user.

762

"kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".

763

"localId": "A String", # The RP local ID of the user.

764

"refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

769

<code class="details" id="uploadAccount">uploadAccount(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

770

<pre>Batch upload existing user accounts.

771

772

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

773

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

774

The object takes the form of:

775

776

{ # Request to upload user account in batch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

777

"allowOverwrite": True or False, # Whether allow overwrite existing account when user local_id exists.

778

"blockSize": 42,

779

"cpuMemCost": 42, # The following 4 fields are for standard scrypt algorithm.

780

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

781

"dkLen": 42,

782

"hashAlgorithm": "A String", # The password hash algorithm.

783

"memoryCost": 42, # Memory cost for hash calculation. Used by scrypt similar algorithms.

784

"parallelization": 42,

785

"rounds": 42, # Rounds for hash calculation. Used by scrypt and similar algorithms.

786

"saltSeparator": "A String", # The salt separator.

787

"sanityCheck": True or False, # If true, backend will do sanity check(including duplicate email and federated id) when uploading account.

788

"signerKey": "A String", # The key for to hash the password.

789

"targetProjectId": "A String", # Specify which project (field value is actually project id) to operate. Only used when provided credential.

790

"users": [ # The account info to be stored.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

791

{ # Template for an individual account info.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

792

"createdAt": "A String", # User creation timestamp.

793

"customAttributes": "A String", # The custom attributes to be set in the user's id token.

794

"customAuth": True or False, # Whether the user is authenticated by the developer.

795

"disabled": True or False, # Whether the user is disabled.

796

"displayName": "A String", # The name of the user.

797

"email": "A String", # The email of the user.

798

"emailVerified": True or False, # Whether the email has been verified.

799

"lastLoginAt": "A String", # last login timestamp.

800

"localId": "A String", # The local ID of the user.

801

"passwordHash": "A String", # The user's hashed password.

802

"passwordUpdatedAt": 3.14, # The timestamp when the password was last updated.

803

"phoneNumber": "A String", # User's phone number.

804

"photoUrl": "A String", # The URL of the user profile photo.

805

"providerUserInfo": [ # The IDP of the user.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

806

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

807

"displayName": "A String", # The user's display name at the IDP.

808

"email": "A String", # User's email at IDP.

809

"federatedId": "A String", # User's identifier at IDP.

810

"phoneNumber": "A String", # User's phone number.

811

"photoUrl": "A String", # The user's photo url at the IDP.

812

"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.

813

"rawId": "A String", # User's raw identifier directly returned from IDP.

814

"screenName": "A String", # User's screen name at Twitter or login name at Github.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

815

},

816

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

817

"rawPassword": "A String", # The user's plain text password.

818

"salt": "A String", # The user's password salt.

819

"screenName": "A String", # User's screen name at Twitter or login name at Github.

820

"validSince": "A String", # Timestamp in seconds for valid login token.

821

"version": 42, # Version of the user's password.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

822

},

823

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

829

830

{ # Respone of uploading accounts in batch.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

831

"error": [ # The error encountered while processing the account info.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

832

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

833

"index": 42, # The index of the malformed account, starting from 0.

834

"message": "A String", # Detailed error message for the account info.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

835

},

836

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

837

"kind": "identitytoolkit#UploadAccountResponse", # The fixed string "identitytoolkit#UploadAccountResponse".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

842

<code class="details" id="verifyAssertion">verifyAssertion(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

843

<pre>Verifies the assertion returned by the IdP.

844

845

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

846

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

847

The object takes the form of:

848

849

{ # Request to verify the IDP assertion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

850

"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.

851

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

852

"idToken": "A String", # The GITKit token of the authenticated user.

853

"instanceId": "A String", # Instance id token of the app.

854

"pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user.

855

"postBody": "A String", # The post body if the request is a HTTP POST.

856

"requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.

857

"returnIdpCredential": True or False, # Whether return 200 and IDP credential rather than throw exception when federated id is already linked.

858

"returnRefreshToken": True or False, # Whether to return refresh tokens.

859

"returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.

860

"sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.

861

"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.

862

"tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

868

869

{ # Response of verifying the IDP assertion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

870

"action": "A String", # The action code.

871

"appInstallationUrl": "A String", # URL for OTA app installation.

872

"appScheme": "A String", # The custom scheme used by mobile app.

873

"context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback.

874

"dateOfBirth": "A String", # The birth date of the IdP account.

875

"displayName": "A String", # The display name of the user.

876

"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.

877

"emailRecycled": True or False, # It's true if the email is recycled.

878

"emailVerified": True or False, # The value is true if the IDP is also the email provider. It means the user owns the email.

879

"errorMessage": "A String", # Client error code.

880

"expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

881

"federatedId": "A String", # The unique ID identifies the IdP account.

882

"firstName": "A String", # The first name of the user.

883

"fullName": "A String", # The full name of the user.

884

"idToken": "A String", # The ID token.

885

"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.

886

"isNewUser": True or False, # True if it's a new user sign-in, false if it's a returning user.

887

"kind": "identitytoolkit#VerifyAssertionResponse", # The fixed string "identitytoolkit#VerifyAssertionResponse".

888

"language": "A String", # The language preference of the user.

889

"lastName": "A String", # The last name of the user.

890

"localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.

891

"needConfirmation": True or False, # Whether the assertion is from a non-trusted IDP and need account linking confirmation.

892

"needEmail": True or False, # Whether need client to supply email to complete the federated login flow.

893

"nickName": "A String", # The nick name of the user.

894

"oauthAccessToken": "A String", # The OAuth2 access token.

895

"oauthAuthorizationCode": "A String", # The OAuth2 authorization code.

896

"oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.

897

"oauthIdToken": "A String", # The OIDC id token.

898

"oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension.

899

"oauthScope": "A String", # The scope for the OpenID OAuth extension.

900

"oauthTokenSecret": "A String", # The OAuth1 access token secret.

901

"originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email.

902

"photoUrl": "A String", # The URI of the public accessible profiel picture.

903

"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.

904

"rawUserInfo": "A String", # Raw IDP-returned user info.

905

"refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.

906

"screenName": "A String", # The screen_name of a Twitter user or the login name at Github.

907

"timeZone": "A String", # The timezone of the user.

908

"verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation.

909

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

910

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

915

<code class="details" id="verifyCustomToken">verifyCustomToken(body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

916

<pre>Verifies the developer asserted ID token.

917

918

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

919

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

920

The object takes the form of:

921

922

{ # Request to verify a custom token

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

923

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

924

"instanceId": "A String", # Instance id token of the app.

925

"returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.

926

"token": "A String", # The custom token to verify

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}

Returns:

An object of the form:

932

933

{ # Response from verifying a custom token

Bu Sun Kim

2020-05-20 12:08:20 -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.

935

"idToken": "A String", # The GITKit token for authenticated user.

936

"isNewUser": True or False, # True if it's a new user sign-in, false if it's a returning user.

937

"kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".

938

"refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

943

<code class="details" id="verifyPassword">verifyPassword(body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

944

<pre>Verifies the user entered password.

945

946

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

947

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

948

The object takes the form of:

949

950

{ # Request to verify the password.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

951

"captchaChallenge": "A String", # The captcha challenge.

952

"captchaResponse": "A String", # Response to the captcha.

953

"delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.

954

"email": "A String", # The email of the user.

955

"idToken": "A String", # The GITKit token of the authenticated user.

956

"instanceId": "A String", # Instance id token of the app.

957

"password": "A String", # The password inputed by the user.

958

"pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user.

959

"returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.

960

"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.

961

"tenantProjectNumber": "A String", # Tenant project number to be used for idp discovery.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

967

968

{ # Request of verifying the password.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

969

"displayName": "A String", # The name of the user.

970

"email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email.

971

"expiresIn": "A String", # If idToken is STS id token, then this field will be expiration time of STS id token in seconds.

972

"idToken": "A String", # The GITKit token for authenticated user.

973

"kind": "identitytoolkit#VerifyPasswordResponse", # The fixed string "identitytoolkit#VerifyPasswordResponse".

974

"localId": "A String", # The RP local ID if it's already been mapped to the IdP account identified by the federated ID.

975

"oauthAccessToken": "A String", # The OAuth2 access token.

976

"oauthAuthorizationCode": "A String", # The OAuth2 authorization code.

977

"oauthExpireIn": 42, # The lifetime in seconds of the OAuth2 access token.

978

"photoUrl": "A String", # The URI of the user's photo at IdP

979

"refreshToken": "A String", # If idToken is STS id token, then this field will be refresh token.

980

"registered": True or False, # Whether the email is registered.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

984

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

985

<code class="details" id="verifyPhoneNumber">verifyPhoneNumber(body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

986

<pre>Verifies ownership of a phone number and creates/updates the user account accordingly.

987

988

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

989

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

990

The object takes the form of:

991

992

{ # Request for Identitytoolkit-VerifyPhoneNumber

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

993

"code": "A String",

994

"idToken": "A String",

995

"operation": "A String",

996

"phoneNumber": "A String",

997

"sessionInfo": "A String", # The session info previously returned by IdentityToolkit-SendVerificationCode.

998

"temporaryProof": "A String",

999

"verificationProof": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

1005

1006

{ # Response for Identitytoolkit-VerifyPhoneNumber

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1007

"expiresIn": "A String",

1008

"idToken": "A String",

1009

"isNewUser": True or False,

1010

"localId": "A String",

1011

"phoneNumber": "A String",

1012

"refreshToken": "A String",

1013

"temporaryProof": "A String",

1014

"temporaryProofExpiresIn": "A String",

1015

"verificationProof": "A String",

1016

"verificationProofExpiresIn": "A String",

Bu Sun Kim