OLD | NEW |
(Empty) | |
| 1 { |
| 2 "basePath": "/identitytoolkit/v3/relyingparty/", |
| 3 "baseUrl": "https://www.googleapis.com/identitytoolkit/v3/relyingparty/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "Identity Toolkit", |
| 6 "description": "Help the third party sites to implement federated login.", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://developers.google.com/identity-toolkit/v3/", |
| 9 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/3Q4T5rCRWv05dybb5cUgUxFbyZs\"", |
| 10 "icons": { |
| 11 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 12 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 13 }, |
| 14 "id": "identitytoolkit:v3", |
| 15 "kind": "discovery#restDescription", |
| 16 "name": "identitytoolkit", |
| 17 "ownerDomain": "google.com", |
| 18 "ownerName": "Google", |
| 19 "parameters": { |
| 20 "alt": { |
| 21 "default": "json", |
| 22 "description": "Data format for the response.", |
| 23 "enum": [ |
| 24 "json" |
| 25 ], |
| 26 "enumDescriptions": [ |
| 27 "Responses with Content-Type of application/json" |
| 28 ], |
| 29 "location": "query", |
| 30 "type": "string" |
| 31 }, |
| 32 "fields": { |
| 33 "description": "Selector specifying which fields to include in a par
tial response.", |
| 34 "location": "query", |
| 35 "type": "string" |
| 36 }, |
| 37 "key": { |
| 38 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 39 "location": "query", |
| 40 "type": "string" |
| 41 }, |
| 42 "oauth_token": { |
| 43 "description": "OAuth 2.0 token for the current user.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "prettyPrint": { |
| 48 "default": "true", |
| 49 "description": "Returns response with indentations and line breaks."
, |
| 50 "location": "query", |
| 51 "type": "boolean" |
| 52 }, |
| 53 "quotaUser": { |
| 54 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
| 58 "userIp": { |
| 59 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 } |
| 63 }, |
| 64 "protocol": "rest", |
| 65 "resources": { |
| 66 "relyingparty": { |
| 67 "methods": { |
| 68 "createAuthUri": { |
| 69 "description": "Creates the URI used by the IdP to authentic
ate the user.", |
| 70 "httpMethod": "POST", |
| 71 "id": "identitytoolkit.relyingparty.createAuthUri", |
| 72 "path": "createAuthUri", |
| 73 "request": { |
| 74 "$ref": "IdentitytoolkitRelyingpartyCreateAuthUriRequest
" |
| 75 }, |
| 76 "response": { |
| 77 "$ref": "CreateAuthUriResponse" |
| 78 } |
| 79 }, |
| 80 "deleteAccount": { |
| 81 "description": "Delete user account.", |
| 82 "httpMethod": "POST", |
| 83 "id": "identitytoolkit.relyingparty.deleteAccount", |
| 84 "path": "deleteAccount", |
| 85 "request": { |
| 86 "$ref": "IdentitytoolkitRelyingpartyDeleteAccountRequest
" |
| 87 }, |
| 88 "response": { |
| 89 "$ref": "DeleteAccountResponse" |
| 90 } |
| 91 }, |
| 92 "downloadAccount": { |
| 93 "description": "Batch download user accounts.", |
| 94 "httpMethod": "POST", |
| 95 "id": "identitytoolkit.relyingparty.downloadAccount", |
| 96 "path": "downloadAccount", |
| 97 "request": { |
| 98 "$ref": "IdentitytoolkitRelyingpartyDownloadAccountReque
st" |
| 99 }, |
| 100 "response": { |
| 101 "$ref": "DownloadAccountResponse" |
| 102 } |
| 103 }, |
| 104 "getAccountInfo": { |
| 105 "description": "Returns the account info.", |
| 106 "httpMethod": "POST", |
| 107 "id": "identitytoolkit.relyingparty.getAccountInfo", |
| 108 "path": "getAccountInfo", |
| 109 "request": { |
| 110 "$ref": "IdentitytoolkitRelyingpartyGetAccountInfoReques
t" |
| 111 }, |
| 112 "response": { |
| 113 "$ref": "GetAccountInfoResponse" |
| 114 } |
| 115 }, |
| 116 "getOobConfirmationCode": { |
| 117 "description": "Get a code for user action confirmation.", |
| 118 "httpMethod": "POST", |
| 119 "id": "identitytoolkit.relyingparty.getOobConfirmationCode", |
| 120 "path": "getOobConfirmationCode", |
| 121 "request": { |
| 122 "$ref": "Relyingparty" |
| 123 }, |
| 124 "response": { |
| 125 "$ref": "GetOobConfirmationCodeResponse" |
| 126 } |
| 127 }, |
| 128 "getPublicKeys": { |
| 129 "description": "Get token signing public key.", |
| 130 "httpMethod": "GET", |
| 131 "id": "identitytoolkit.relyingparty.getPublicKeys", |
| 132 "path": "publicKeys", |
| 133 "response": { |
| 134 "$ref": "IdentitytoolkitRelyingpartyGetPublicKeysRespons
e" |
| 135 } |
| 136 }, |
| 137 "resetPassword": { |
| 138 "description": "Set account info for a user.", |
| 139 "httpMethod": "POST", |
| 140 "id": "identitytoolkit.relyingparty.resetPassword", |
| 141 "path": "resetPassword", |
| 142 "request": { |
| 143 "$ref": "IdentitytoolkitRelyingpartyResetPasswordRequest
" |
| 144 }, |
| 145 "response": { |
| 146 "$ref": "ResetPasswordResponse" |
| 147 } |
| 148 }, |
| 149 "setAccountInfo": { |
| 150 "description": "Set account info for a user.", |
| 151 "httpMethod": "POST", |
| 152 "id": "identitytoolkit.relyingparty.setAccountInfo", |
| 153 "path": "setAccountInfo", |
| 154 "request": { |
| 155 "$ref": "IdentitytoolkitRelyingpartySetAccountInfoReques
t" |
| 156 }, |
| 157 "response": { |
| 158 "$ref": "SetAccountInfoResponse" |
| 159 } |
| 160 }, |
| 161 "uploadAccount": { |
| 162 "description": "Batch upload existing user accounts.", |
| 163 "httpMethod": "POST", |
| 164 "id": "identitytoolkit.relyingparty.uploadAccount", |
| 165 "path": "uploadAccount", |
| 166 "request": { |
| 167 "$ref": "IdentitytoolkitRelyingpartyUploadAccountRequest
" |
| 168 }, |
| 169 "response": { |
| 170 "$ref": "UploadAccountResponse" |
| 171 } |
| 172 }, |
| 173 "verifyAssertion": { |
| 174 "description": "Verifies the assertion returned by the IdP."
, |
| 175 "httpMethod": "POST", |
| 176 "id": "identitytoolkit.relyingparty.verifyAssertion", |
| 177 "path": "verifyAssertion", |
| 178 "request": { |
| 179 "$ref": "IdentitytoolkitRelyingpartyVerifyAssertionReque
st" |
| 180 }, |
| 181 "response": { |
| 182 "$ref": "VerifyAssertionResponse" |
| 183 } |
| 184 }, |
| 185 "verifyPassword": { |
| 186 "description": "Verifies the user entered password.", |
| 187 "httpMethod": "POST", |
| 188 "id": "identitytoolkit.relyingparty.verifyPassword", |
| 189 "path": "verifyPassword", |
| 190 "request": { |
| 191 "$ref": "IdentitytoolkitRelyingpartyVerifyPasswordReques
t" |
| 192 }, |
| 193 "response": { |
| 194 "$ref": "VerifyPasswordResponse" |
| 195 } |
| 196 } |
| 197 } |
| 198 } |
| 199 }, |
| 200 "revision": "20140717", |
| 201 "rootUrl": "https://www.googleapis.com/", |
| 202 "schemas": { |
| 203 "CreateAuthUriResponse": { |
| 204 "description": "Response of creating the IDP authentication URL.", |
| 205 "id": "CreateAuthUriResponse", |
| 206 "properties": { |
| 207 "authUri": { |
| 208 "description": "The URI used by the IDP to authenticate the
user.", |
| 209 "type": "string" |
| 210 }, |
| 211 "forExistingProvider": { |
| 212 "description": "True if the authUri is for user's existing p
rovider.", |
| 213 "type": "boolean" |
| 214 }, |
| 215 "kind": { |
| 216 "default": "identitytoolkit#CreateAuthUriResponse", |
| 217 "description": "The fixed string identitytoolkit#CreateAuthU
riResponse\".", |
| 218 "type": "string" |
| 219 }, |
| 220 "providerId": { |
| 221 "description": "The provider ID of the auth URI.", |
| 222 "type": "string" |
| 223 }, |
| 224 "registered": { |
| 225 "description": "Whether the user is registered if the identi
fier is an email.", |
| 226 "type": "boolean" |
| 227 } |
| 228 }, |
| 229 "type": "object" |
| 230 }, |
| 231 "DeleteAccountResponse": { |
| 232 "description": "Respone of deleting account.", |
| 233 "id": "DeleteAccountResponse", |
| 234 "properties": { |
| 235 "kind": { |
| 236 "default": "identitytoolkit#DeleteAccountResponse", |
| 237 "description": "The fixed string \"identitytoolkit#DeleteAcc
ountResponse\".", |
| 238 "type": "string" |
| 239 } |
| 240 }, |
| 241 "type": "object" |
| 242 }, |
| 243 "DownloadAccountResponse": { |
| 244 "description": "Respone of downloading accounts in batch.", |
| 245 "id": "DownloadAccountResponse", |
| 246 "properties": { |
| 247 "kind": { |
| 248 "default": "identitytoolkit#DownloadAccountResponse", |
| 249 "description": "The fixed string \"identitytoolkit#DownloadA
ccountResponse\".", |
| 250 "type": "string" |
| 251 }, |
| 252 "nextPageToken": { |
| 253 "description": "The next page token. To be used in a subsequ
ent request to return the next page of results.", |
| 254 "type": "string" |
| 255 }, |
| 256 "users": { |
| 257 "description": "The user accounts data.", |
| 258 "items": { |
| 259 "$ref": "UserInfo" |
| 260 }, |
| 261 "type": "array" |
| 262 } |
| 263 }, |
| 264 "type": "object" |
| 265 }, |
| 266 "GetAccountInfoResponse": { |
| 267 "description": "Response of getting account information.", |
| 268 "id": "GetAccountInfoResponse", |
| 269 "properties": { |
| 270 "kind": { |
| 271 "default": "identitytoolkit#GetAccountInfoResponse", |
| 272 "description": "The fixed string \"identitytoolkit#GetAccoun
tInfoResponse\".", |
| 273 "type": "string" |
| 274 }, |
| 275 "users": { |
| 276 "description": "The info of the users.", |
| 277 "items": { |
| 278 "$ref": "UserInfo" |
| 279 }, |
| 280 "type": "array" |
| 281 } |
| 282 }, |
| 283 "type": "object" |
| 284 }, |
| 285 "GetOobConfirmationCodeResponse": { |
| 286 "description": "Response of getting a code for user confirmation (re
set password, change email etc.).", |
| 287 "id": "GetOobConfirmationCodeResponse", |
| 288 "properties": { |
| 289 "kind": { |
| 290 "default": "identitytoolkit#GetOobConfirmationCodeResponse", |
| 291 "description": "The fixed string \"identitytoolkit#GetOobCon
firmationCodeResponse\".", |
| 292 "type": "string" |
| 293 }, |
| 294 "oobCode": { |
| 295 "description": "The code to be send to the user.", |
| 296 "type": "string" |
| 297 } |
| 298 }, |
| 299 "type": "object" |
| 300 }, |
| 301 "IdentitytoolkitRelyingpartyCreateAuthUriRequest": { |
| 302 "description": "Request to get the IDP authentication URL.", |
| 303 "id": "IdentitytoolkitRelyingpartyCreateAuthUriRequest", |
| 304 "properties": { |
| 305 "appId": { |
| 306 "description": "The app ID of the mobile app, base64(CERT_SH
A1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.", |
| 307 "type": "string" |
| 308 }, |
| 309 "clientId": { |
| 310 "description": "The relying party OAuth client ID.", |
| 311 "type": "string" |
| 312 }, |
| 313 "context": { |
| 314 "description": "The opaque value used by the client to maint
ain context info between the authentication request and the IDP callback.", |
| 315 "type": "string" |
| 316 }, |
| 317 "continueUri": { |
| 318 "description": "The URI to which the IDP redirects the user
after the federated login flow.", |
| 319 "type": "string" |
| 320 }, |
| 321 "identifier": { |
| 322 "description": "The email or federated ID of the user.", |
| 323 "type": "string" |
| 324 }, |
| 325 "openidRealm": { |
| 326 "description": "Optional realm for OpenID protocol. The sub
string \"scheme://domain:port\" of the param \"continueUri\" is used if this is
not set.", |
| 327 "type": "string" |
| 328 }, |
| 329 "otaApp": { |
| 330 "description": "The native app package for OTA installation.
", |
| 331 "type": "string" |
| 332 }, |
| 333 "providerId": { |
| 334 "description": "The IdP ID. For white listed IdPs it's a sho
rt domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenI
D IdPs it's the OP identifier.", |
| 335 "type": "string" |
| 336 } |
| 337 }, |
| 338 "type": "object" |
| 339 }, |
| 340 "IdentitytoolkitRelyingpartyDeleteAccountRequest": { |
| 341 "description": "Request to delete account.", |
| 342 "id": "IdentitytoolkitRelyingpartyDeleteAccountRequest", |
| 343 "properties": { |
| 344 "localId": { |
| 345 "description": "The local ID of the user.", |
| 346 "type": "string" |
| 347 } |
| 348 }, |
| 349 "type": "object" |
| 350 }, |
| 351 "IdentitytoolkitRelyingpartyDownloadAccountRequest": { |
| 352 "description": "Request to download user account in batch.", |
| 353 "id": "IdentitytoolkitRelyingpartyDownloadAccountRequest", |
| 354 "properties": { |
| 355 "maxResults": { |
| 356 "description": "The max number of results to return in the r
esponse.", |
| 357 "format": "uint32", |
| 358 "type": "integer" |
| 359 }, |
| 360 "nextPageToken": { |
| 361 "description": "The token for the next page. This should be
taken from the previous response.", |
| 362 "type": "string" |
| 363 } |
| 364 }, |
| 365 "type": "object" |
| 366 }, |
| 367 "IdentitytoolkitRelyingpartyGetAccountInfoRequest": { |
| 368 "description": "Request to get the account information.", |
| 369 "id": "IdentitytoolkitRelyingpartyGetAccountInfoRequest", |
| 370 "properties": { |
| 371 "email": { |
| 372 "description": "The list of emails of the users to inquiry."
, |
| 373 "items": { |
| 374 "type": "string" |
| 375 }, |
| 376 "type": "array" |
| 377 }, |
| 378 "idToken": { |
| 379 "description": "The GITKit token of the authenticated user."
, |
| 380 "type": "string" |
| 381 }, |
| 382 "localId": { |
| 383 "description": "The list of local ID's of the users to inqui
ry.", |
| 384 "items": { |
| 385 "type": "string" |
| 386 }, |
| 387 "type": "array" |
| 388 } |
| 389 }, |
| 390 "type": "object" |
| 391 }, |
| 392 "IdentitytoolkitRelyingpartyGetPublicKeysResponse": { |
| 393 "additionalProperties": { |
| 394 "type": "string" |
| 395 }, |
| 396 "description": "Respone of getting public keys.", |
| 397 "id": "IdentitytoolkitRelyingpartyGetPublicKeysResponse", |
| 398 "type": "object" |
| 399 }, |
| 400 "IdentitytoolkitRelyingpartyResetPasswordRequest": { |
| 401 "description": "Request to reset the password.", |
| 402 "id": "IdentitytoolkitRelyingpartyResetPasswordRequest", |
| 403 "properties": { |
| 404 "email": { |
| 405 "description": "The email address of the user.", |
| 406 "type": "string" |
| 407 }, |
| 408 "newPassword": { |
| 409 "description": "The new password inputted by the user.", |
| 410 "type": "string" |
| 411 }, |
| 412 "oldPassword": { |
| 413 "description": "The old password inputted by the user.", |
| 414 "type": "string" |
| 415 }, |
| 416 "oobCode": { |
| 417 "description": "The confirmation code.", |
| 418 "type": "string" |
| 419 } |
| 420 }, |
| 421 "type": "object" |
| 422 }, |
| 423 "IdentitytoolkitRelyingpartySetAccountInfoRequest": { |
| 424 "description": "Request to set the account information.", |
| 425 "id": "IdentitytoolkitRelyingpartySetAccountInfoRequest", |
| 426 "properties": { |
| 427 "captchaChallenge": { |
| 428 "description": "The captcha challenge.", |
| 429 "type": "string" |
| 430 }, |
| 431 "captchaResponse": { |
| 432 "description": "Response to the captcha.", |
| 433 "type": "string" |
| 434 }, |
| 435 "displayName": { |
| 436 "description": "The name of the user.", |
| 437 "type": "string" |
| 438 }, |
| 439 "email": { |
| 440 "description": "The email of the user.", |
| 441 "type": "string" |
| 442 }, |
| 443 "emailVerified": { |
| 444 "description": "Mark the email as verified or not.", |
| 445 "type": "boolean" |
| 446 }, |
| 447 "idToken": { |
| 448 "description": "The GITKit token of the authenticated user."
, |
| 449 "type": "string" |
| 450 }, |
| 451 "localId": { |
| 452 "description": "The local ID of the user.", |
| 453 "type": "string" |
| 454 }, |
| 455 "oobCode": { |
| 456 "description": "The out-of-band code of the change email req
uest.", |
| 457 "type": "string" |
| 458 }, |
| 459 "password": { |
| 460 "description": "The new password of the user.", |
| 461 "type": "string" |
| 462 }, |
| 463 "provider": { |
| 464 "description": "The associated IDPs of the user.", |
| 465 "items": { |
| 466 "type": "string" |
| 467 }, |
| 468 "type": "array" |
| 469 }, |
| 470 "upgradeToFederatedLogin": { |
| 471 "description": "Mark the user to upgrade to federated login.
", |
| 472 "type": "boolean" |
| 473 } |
| 474 }, |
| 475 "type": "object" |
| 476 }, |
| 477 "IdentitytoolkitRelyingpartyUploadAccountRequest": { |
| 478 "description": "Request to upload user account in batch.", |
| 479 "id": "IdentitytoolkitRelyingpartyUploadAccountRequest", |
| 480 "properties": { |
| 481 "hashAlgorithm": { |
| 482 "description": "The password hash algorithm.", |
| 483 "type": "string" |
| 484 }, |
| 485 "memoryCost": { |
| 486 "description": "Memory cost for hash calculation. Used by sc
rypt similar algorithms.", |
| 487 "format": "int32", |
| 488 "type": "integer" |
| 489 }, |
| 490 "rounds": { |
| 491 "description": "Rounds for hash calculation. Used by scrypt
and similar algorithms.", |
| 492 "format": "int32", |
| 493 "type": "integer" |
| 494 }, |
| 495 "saltSeparator": { |
| 496 "description": "The salt separator.", |
| 497 "format": "byte", |
| 498 "type": "string" |
| 499 }, |
| 500 "signerKey": { |
| 501 "description": "The key for to hash the password.", |
| 502 "format": "byte", |
| 503 "type": "string" |
| 504 }, |
| 505 "users": { |
| 506 "description": "The account info to be stored.", |
| 507 "items": { |
| 508 "$ref": "UserInfo" |
| 509 }, |
| 510 "type": "array" |
| 511 } |
| 512 }, |
| 513 "type": "object" |
| 514 }, |
| 515 "IdentitytoolkitRelyingpartyVerifyAssertionRequest": { |
| 516 "description": "Request to verify the IDP assertion.", |
| 517 "id": "IdentitytoolkitRelyingpartyVerifyAssertionRequest", |
| 518 "properties": { |
| 519 "pendingIdToken": { |
| 520 "description": "The GITKit token for the non-trusted IDP pen
ding to be confirmed by the user.", |
| 521 "type": "string" |
| 522 }, |
| 523 "postBody": { |
| 524 "description": "The post body if the request is a HTTP POST.
", |
| 525 "type": "string" |
| 526 }, |
| 527 "requestUri": { |
| 528 "description": "The URI to which the IDP redirects the user
back. It may contain federated login result params added by the IDP.", |
| 529 "type": "string" |
| 530 } |
| 531 }, |
| 532 "type": "object" |
| 533 }, |
| 534 "IdentitytoolkitRelyingpartyVerifyPasswordRequest": { |
| 535 "description": "Request to verify the password.", |
| 536 "id": "IdentitytoolkitRelyingpartyVerifyPasswordRequest", |
| 537 "properties": { |
| 538 "captchaChallenge": { |
| 539 "description": "The captcha challenge.", |
| 540 "type": "string" |
| 541 }, |
| 542 "captchaResponse": { |
| 543 "description": "Response to the captcha.", |
| 544 "type": "string" |
| 545 }, |
| 546 "email": { |
| 547 "description": "The email of the user.", |
| 548 "type": "string" |
| 549 }, |
| 550 "password": { |
| 551 "description": "The password inputed by the user.", |
| 552 "type": "string" |
| 553 }, |
| 554 "pendingIdToken": { |
| 555 "description": "The GITKit token for the non-trusted IDP, wh
ich is to be confirmed by the user.", |
| 556 "type": "string" |
| 557 } |
| 558 }, |
| 559 "type": "object" |
| 560 }, |
| 561 "Relyingparty": { |
| 562 "description": "Request of getting a code for user confirmation (res
et password, change email etc.)", |
| 563 "id": "Relyingparty", |
| 564 "properties": { |
| 565 "captchaResp": { |
| 566 "description": "The recaptcha response from the user.", |
| 567 "type": "string" |
| 568 }, |
| 569 "challenge": { |
| 570 "description": "The recaptcha challenge presented to the use
r.", |
| 571 "type": "string" |
| 572 }, |
| 573 "email": { |
| 574 "description": "The email of the user.", |
| 575 "type": "string" |
| 576 }, |
| 577 "idToken": { |
| 578 "description": "The user's Gitkit login token for email chan
ge.", |
| 579 "type": "string" |
| 580 }, |
| 581 "kind": { |
| 582 "default": "identitytoolkit#relyingparty", |
| 583 "description": "The fixed string \"identitytoolkit#relyingpa
rty\".", |
| 584 "type": "string" |
| 585 }, |
| 586 "newEmail": { |
| 587 "description": "The new email if the code is for email chang
e.", |
| 588 "type": "string" |
| 589 }, |
| 590 "requestType": { |
| 591 "description": "The request type.", |
| 592 "type": "string" |
| 593 }, |
| 594 "userIp": { |
| 595 "description": "The IP address of the user.", |
| 596 "type": "string" |
| 597 } |
| 598 }, |
| 599 "type": "object" |
| 600 }, |
| 601 "ResetPasswordResponse": { |
| 602 "description": "Response of resetting the password.", |
| 603 "id": "ResetPasswordResponse", |
| 604 "properties": { |
| 605 "email": { |
| 606 "description": "The user's email.", |
| 607 "type": "string" |
| 608 }, |
| 609 "kind": { |
| 610 "default": "identitytoolkit#ResetPasswordResponse", |
| 611 "description": "The fixed string \"identitytoolkit#ResetPass
wordResponse\".", |
| 612 "type": "string" |
| 613 } |
| 614 }, |
| 615 "type": "object" |
| 616 }, |
| 617 "SetAccountInfoResponse": { |
| 618 "description": "Respone of setting the account information.", |
| 619 "id": "SetAccountInfoResponse", |
| 620 "properties": { |
| 621 "displayName": { |
| 622 "description": "The name of the user.", |
| 623 "type": "string" |
| 624 }, |
| 625 "email": { |
| 626 "description": "The email of the user.", |
| 627 "type": "string" |
| 628 }, |
| 629 "idToken": { |
| 630 "description": "The Gitkit id token to login the newly sign
up user.", |
| 631 "type": "string" |
| 632 }, |
| 633 "kind": { |
| 634 "default": "identitytoolkit#SetAccountInfoResponse", |
| 635 "description": "The fixed string \"identitytoolkit#SetAccoun
tInfoResponse\".", |
| 636 "type": "string" |
| 637 }, |
| 638 "providerUserInfo": { |
| 639 "description": "The user's profiles at the associated IdPs."
, |
| 640 "items": { |
| 641 "properties": { |
| 642 "displayName": { |
| 643 "description": "The user's display name at the I
DP.", |
| 644 "type": "string" |
| 645 }, |
| 646 "photoUrl": { |
| 647 "description": "The user's photo url at the IDP.
", |
| 648 "type": "string" |
| 649 }, |
| 650 "providerId": { |
| 651 "description": "The IdP ID. For whitelisted IdPs
it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. Fo
r other OpenID IdPs it's the OP identifier.", |
| 652 "type": "string" |
| 653 } |
| 654 }, |
| 655 "type": "object" |
| 656 }, |
| 657 "type": "array" |
| 658 } |
| 659 }, |
| 660 "type": "object" |
| 661 }, |
| 662 "UploadAccountResponse": { |
| 663 "description": "Respone of uploading accounts in batch.", |
| 664 "id": "UploadAccountResponse", |
| 665 "properties": { |
| 666 "error": { |
| 667 "description": "The error encountered while processing the a
ccount info.", |
| 668 "items": { |
| 669 "properties": { |
| 670 "index": { |
| 671 "description": "The index of the malformed accou
nt, starting from 0.", |
| 672 "format": "int32", |
| 673 "type": "integer" |
| 674 }, |
| 675 "message": { |
| 676 "description": "Detailed error message for the a
ccount info.", |
| 677 "type": "string" |
| 678 } |
| 679 }, |
| 680 "type": "object" |
| 681 }, |
| 682 "type": "array" |
| 683 }, |
| 684 "kind": { |
| 685 "default": "identitytoolkit#UploadAccountResponse", |
| 686 "description": "The fixed string \"identitytoolkit#UploadAcc
ountResponse\".", |
| 687 "type": "string" |
| 688 } |
| 689 }, |
| 690 "type": "object" |
| 691 }, |
| 692 "UserInfo": { |
| 693 "description": "Template for an individual account info.", |
| 694 "id": "UserInfo", |
| 695 "properties": { |
| 696 "displayName": { |
| 697 "description": "The name of the user.", |
| 698 "type": "string" |
| 699 }, |
| 700 "email": { |
| 701 "description": "The email of the user.", |
| 702 "type": "string" |
| 703 }, |
| 704 "emailVerified": { |
| 705 "description": "Whether the email has been verified.", |
| 706 "type": "boolean" |
| 707 }, |
| 708 "localId": { |
| 709 "description": "The local ID of the user.", |
| 710 "type": "string" |
| 711 }, |
| 712 "passwordHash": { |
| 713 "description": "The user's hashed password.", |
| 714 "format": "byte", |
| 715 "type": "string" |
| 716 }, |
| 717 "passwordUpdatedAt": { |
| 718 "description": "The timestamp when the password was last upd
ated.", |
| 719 "format": "double", |
| 720 "type": "number" |
| 721 }, |
| 722 "photoUrl": { |
| 723 "description": "The URL of the user profile photo.", |
| 724 "type": "string" |
| 725 }, |
| 726 "providerUserInfo": { |
| 727 "description": "The IDP of the user.", |
| 728 "items": { |
| 729 "properties": { |
| 730 "displayName": { |
| 731 "description": "The user's display name at the I
DP.", |
| 732 "type": "string" |
| 733 }, |
| 734 "federatedId": { |
| 735 "description": "User's identifier at IDP.", |
| 736 "type": "string" |
| 737 }, |
| 738 "photoUrl": { |
| 739 "description": "The user's photo url at the IDP.
", |
| 740 "type": "string" |
| 741 }, |
| 742 "providerId": { |
| 743 "description": "The IdP ID. For white listed IdP
s it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. F
or other OpenID IdPs it's the OP identifier.", |
| 744 "type": "string" |
| 745 } |
| 746 }, |
| 747 "type": "object" |
| 748 }, |
| 749 "type": "array" |
| 750 }, |
| 751 "salt": { |
| 752 "description": "The user's password salt.", |
| 753 "format": "byte", |
| 754 "type": "string" |
| 755 }, |
| 756 "version": { |
| 757 "description": "Version of the user's password.", |
| 758 "format": "int32", |
| 759 "type": "integer" |
| 760 } |
| 761 }, |
| 762 "type": "object" |
| 763 }, |
| 764 "VerifyAssertionResponse": { |
| 765 "description": "Response of verifying the IDP assertion.", |
| 766 "id": "VerifyAssertionResponse", |
| 767 "properties": { |
| 768 "action": { |
| 769 "description": "The action code.", |
| 770 "type": "string" |
| 771 }, |
| 772 "appInstallationUrl": { |
| 773 "description": "URL for OTA app installation.", |
| 774 "type": "string" |
| 775 }, |
| 776 "appScheme": { |
| 777 "description": "The custom scheme used by mobile app.", |
| 778 "type": "string" |
| 779 }, |
| 780 "context": { |
| 781 "description": "The opaque value used by the client to maint
ain context info between the authentication request and the IDP callback.", |
| 782 "type": "string" |
| 783 }, |
| 784 "dateOfBirth": { |
| 785 "description": "The birth date of the IdP account.", |
| 786 "type": "string" |
| 787 }, |
| 788 "displayName": { |
| 789 "description": "The display name of the user.", |
| 790 "type": "string" |
| 791 }, |
| 792 "email": { |
| 793 "description": "The email returned by the IdP. NOTE: The fed
erated login user may not own the email.", |
| 794 "type": "string" |
| 795 }, |
| 796 "emailRecycled": { |
| 797 "description": "It's true if the email is recycled.", |
| 798 "type": "boolean" |
| 799 }, |
| 800 "emailVerified": { |
| 801 "description": "The value is true if the IDP is also the ema
il provider. It means the user owns the email.", |
| 802 "type": "boolean" |
| 803 }, |
| 804 "federatedId": { |
| 805 "description": "The unique ID identifies the IdP account.", |
| 806 "type": "string" |
| 807 }, |
| 808 "firstName": { |
| 809 "description": "The first name of the user.", |
| 810 "type": "string" |
| 811 }, |
| 812 "fullName": { |
| 813 "description": "The full name of the user.", |
| 814 "type": "string" |
| 815 }, |
| 816 "idToken": { |
| 817 "description": "The ID token.", |
| 818 "type": "string" |
| 819 }, |
| 820 "inputEmail": { |
| 821 "description": "It's the identifier param in the createAuthU
ri request if the identifier is an email. It can be used to check whether the us
er input email is different from the asserted email.", |
| 822 "type": "string" |
| 823 }, |
| 824 "kind": { |
| 825 "default": "identitytoolkit#VerifyAssertionResponse", |
| 826 "description": "The fixed string \"identitytoolkit#VerifyAss
ertionResponse\".", |
| 827 "type": "string" |
| 828 }, |
| 829 "language": { |
| 830 "description": "The language preference of the user.", |
| 831 "type": "string" |
| 832 }, |
| 833 "lastName": { |
| 834 "description": "The last name of the user.", |
| 835 "type": "string" |
| 836 }, |
| 837 "localId": { |
| 838 "description": "The RP local ID if it's already been mapped
to the IdP account identified by the federated ID.", |
| 839 "type": "string" |
| 840 }, |
| 841 "needConfirmation": { |
| 842 "description": "Whether the assertion is from a non-trusted
IDP and need account linking confirmation.", |
| 843 "type": "boolean" |
| 844 }, |
| 845 "nickName": { |
| 846 "description": "The nick name of the user.", |
| 847 "type": "string" |
| 848 }, |
| 849 "oauthRequestToken": { |
| 850 "description": "The user approved request token for the Open
ID OAuth extension.", |
| 851 "type": "string" |
| 852 }, |
| 853 "oauthScope": { |
| 854 "description": "The scope for the OpenID OAuth extension.", |
| 855 "type": "string" |
| 856 }, |
| 857 "originalEmail": { |
| 858 "description": "The original email stored in the mapping sto
rage. It's returned when the federated ID is associated to a different email.", |
| 859 "type": "string" |
| 860 }, |
| 861 "photoUrl": { |
| 862 "description": "The URI of the public accessible profiel pic
ture.", |
| 863 "type": "string" |
| 864 }, |
| 865 "providerId": { |
| 866 "description": "The IdP ID. For white listed IdPs it's a sho
rt domain name e.g. google.com, aol.com, live.net and yahoo.com. If the \"provid
erId\" 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 c
reateAuthUri request. The domain part of the federated ID is returned.", |
| 867 "type": "string" |
| 868 }, |
| 869 "timeZone": { |
| 870 "description": "The timezone of the user.", |
| 871 "type": "string" |
| 872 }, |
| 873 "verifiedProvider": { |
| 874 "description": "When action is 'map', contains the idps whic
h can be used for confirmation.", |
| 875 "items": { |
| 876 "type": "string" |
| 877 }, |
| 878 "type": "array" |
| 879 } |
| 880 }, |
| 881 "type": "object" |
| 882 }, |
| 883 "VerifyPasswordResponse": { |
| 884 "description": "Request of verifying the password.", |
| 885 "id": "VerifyPasswordResponse", |
| 886 "properties": { |
| 887 "displayName": { |
| 888 "description": "The name of the user.", |
| 889 "type": "string" |
| 890 }, |
| 891 "email": { |
| 892 "description": "The email returned by the IdP. NOTE: The fed
erated login user may not own the email.", |
| 893 "type": "string" |
| 894 }, |
| 895 "idToken": { |
| 896 "description": "The GITKit token for authenticated user.", |
| 897 "type": "string" |
| 898 }, |
| 899 "kind": { |
| 900 "default": "identitytoolkit#VerifyPasswordResponse", |
| 901 "description": "The fixed string \"identitytoolkit#VerifyPas
swordResponse\".", |
| 902 "type": "string" |
| 903 }, |
| 904 "localId": { |
| 905 "description": "The RP local ID if it's already been mapped
to the IdP account identified by the federated ID.", |
| 906 "type": "string" |
| 907 }, |
| 908 "photoUrl": { |
| 909 "description": "The URI of the user's photo at IdP", |
| 910 "type": "string" |
| 911 }, |
| 912 "registered": { |
| 913 "description": "Whether the email is registered.", |
| 914 "type": "boolean" |
| 915 } |
| 916 }, |
| 917 "type": "object" |
| 918 } |
| 919 }, |
| 920 "servicePath": "identitytoolkit/v3/relyingparty/", |
| 921 "title": "Google Identity Toolkit API", |
| 922 "version": "v3" |
| 923 } |
OLD | NEW |