openapi-directory/api/googleapis.com/identitytoolkit.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Help the third party sites to implement federated login.","title":"Google Identity Toolkit","version":"v3","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["security"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/identitytoolkit/v3/rest","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"identitytoolkit"},"externalDocs":{"url":"https://developers.google.com/identity-toolkit/v3/"},"tags":[{"name":"relyingparty"}],"paths":{"/createAuthUri":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates the URI used by the IdP to authenticate the user.","operationId":"identitytoolkit.relyingparty.createAuthUri","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyCreateAuthUriRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateAuthUriResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/deleteAccount":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Delete user account.","operationId":"identitytoolkit.relyingparty.deleteAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyDeleteAccountRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteAccountResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/downloadAccount":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Batch download user accounts.","operationId":"identitytoolkit.relyingparty.downloadAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyDownloadAccountRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadAccountResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/firebase"]}],"tags":["relyingparty"]}},"/emailLinkSignin":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Reset password for a user.","operationId":"identitytoolkit.relyingparty.emailLinkSignin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyEmailLinkSigninRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EmailLinkSigninResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/getAccountInfo":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Returns the account info.","operationId":"identitytoolkit.relyingparty.getAccountInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyGetAccountInfoRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAccountInfoResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/getOobConfirmationCode":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Get a code for user action confirmation.","operationId":"identitytoolkit.relyingparty.getOobConfirmationCode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Relyingparty"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetOobConfirmationCodeResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/getProjectConfig":{"get":{"description":"Get project configuration.","operationId":"identitytoolkit.relyingparty.getProjectConfig","parameters":[{"description":"Delegated GCP project number of the request.","in":"query","name":"delegatedProjectNumber","schema":{"type":"string"}},{"description":"GCP project number of the request.","in":"query","name":"projectNumber","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyGetProjectConfigResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/getRecaptchaParam":{"get":{"description":"Get recaptcha secure param.","operationId":"identitytoolkit.relyingparty.getRecaptchaParam","responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetRecaptchaParamResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/publicKeys":{"get":{"description":"Get token signing public key.","operationId":"identitytoolkit.relyingparty.getPublicKeys","responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyGetPublicKeysResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/resetPassword":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Reset password for a user.","operationId":"identitytoolkit.relyingparty.resetPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyResetPasswordRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResetPasswordResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/sendVerificationCode":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Send SMS verification code.","operationId":"identitytoolkit.relyingparty.sendVerificationCode","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySendVerificationCodeRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySendVerificationCodeResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/setAccountInfo":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Set account info for a user.","operationId":"identitytoolkit.relyingparty.setAccountInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySetAccountInfoRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SetAccountInfoResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/setProjectConfig":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Set project configuration.","operationId":"identitytoolkit.relyingparty.setProjectConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySetProjectConfigRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySetProjectConfigResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/signOutUser":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Sign out user.","operationId":"identitytoolkit.relyingparty.signOutUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySignOutUserRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySignOutUserResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/signupNewUser":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Signup new user.","operationId":"identitytoolkit.relyingparty.signupNewUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartySignupNewUserRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SignupNewUserResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/uploadAccount":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Batch upload existing user accounts.","operationId":"identitytoolkit.relyingparty.uploadAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyUploadAccountRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UploadAccountResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/firebase"]}],"tags":["relyingparty"]}},"/verifyAssertion":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Verifies the assertion returned by the IdP.","operationId":"identitytoolkit.relyingparty.verifyAssertion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyVerifyAssertionRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VerifyAssertionResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/verifyCustomToken":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Verifies the developer asserted ID token.","operationId":"identitytoolkit.relyingparty.verifyCustomToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyVerifyCustomTokenRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VerifyCustomTokenResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/verifyPassword":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Verifies the user entered password.","operationId":"identitytoolkit.relyingparty.verifyPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyVerifyPasswordRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/VerifyPasswordResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}},"/verifyPhoneNumber":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Verifies ownership of a phone number and creates/updates the user account accordingly.","operationId":"identitytoolkit.relyingparty.verifyPhoneNumber","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["relyingparty"]}}},"servers":[{"url":"https://www.googleapis.com/identitytoolkit/v3/relyingparty"}],"components":{"parameters":{"alt":{"description":"Data format for the response.","in":"query","name":"alt","schema":{"type":"string","enum":["json"],"default":"json"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"userIp":{"description":"Deprecated. Please use quotaUser instead.","in":"query","name":"userIp","schema":{"type":"string"}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services","https://www.googleapis.com/auth/firebase":"View and administer all your Firebase data and settings"}}}}},"schemas":{"CreateAuthUriResponse":{"description":"Response of creating the IDP authentication URL.","properties":{"allProviders":{"description":"all providers the user has once used to do federated login","items":{"type":"string"},"type":"array"},"authUri":{"description":"The URI used by the IDP to authenticate the user.","type":"string"},"captchaRequired":{"description":"True if captcha is required.","type":"boolean"},"forExistingProvider":{"description":"True if the authUri is for user's existing provider.","type":"boolean"},"kind":{"default":"identitytoolkit#CreateAuthUriResponse","description":"The fixed string identitytoolkit#CreateAuthUriResponse\".","type":"string"},"providerId":{"description":"The provider ID of the auth URI.","type":"string"},"registered":{"description":"Whether the user is registered if the identifier is an email.","type":"boolean"},"sessionId":{"description":"Session ID which should be passed in the following verifyAssertion request.","type":"string"},"signinMethods":{"description":"All sign-in methods this user has used.","items":{"type":"string"},"type":"array"}},"type":"object"},"DeleteAccountResponse":{"description":"Respone of deleting account.","properties":{"kind":{"default":"identitytoolkit#DeleteAccountResponse","description":"The fixed string \"identitytoolkit#DeleteAccountResponse\".","type":"string"}},"type":"object"},"DownloadAccountResponse":{"description":"Response of downloading accounts in batch.","properties":{"kind":{"default":"identitytoolkit#DownloadAccountResponse","description":"The fixed string \"identitytoolkit#DownloadAccountResponse\".","type":"string"},"nextPageToken":{"description":"The next page token. To be used in a subsequent request to return the next page of results.","type":"string"},"users":{"description":"The user accounts data.","items":{"$ref":"#/components/schemas/UserInfo"},"type":"array"}},"type":"object"},"EmailLinkSigninResponse":{"description":"Response of email signIn.","properties":{"email":{"description":"The user's email.","type":"string"},"expiresIn":{"description":"Expiration time of STS id token in seconds.","format":"int64","type":"string"},"idToken":{"description":"The STS id token to login the newly signed in user.","type":"string"},"isNewUser":{"description":"Whether the user is new.","type":"boolean"},"kind":{"default":"identitytoolkit#EmailLinkSigninResponse","description":"The fixed string \"identitytoolkit#EmailLinkSigninResponse\".","type":"string"},"localId":{"description":"The RP local ID of the user.","type":"string"},"refreshToken":{"description":"The refresh token for the signed in user.","type":"string"}},"type":"object"},"EmailTemplate":{"description":"Template for an email template.","properties":{"body":{"description":"Email body.","type":"string"},"format":{"description":"Email body format.","type":"string"},"from":{"description":"From address of the email.","type":"string"},"fromDisplayName":{"description":"From display name.","type":"string"},"replyTo":{"description":"Reply-to address.","type":"string"},"subject":{"description":"Subject of the email.","type":"string"}},"type":"object"},"GetAccountInfoResponse":{"description":"Response of getting account information.","properties":{"kind":{"default":"identitytoolkit#GetAccountInfoResponse","description":"The fixed string \"identitytoolkit#GetAccountInfoResponse\".","type":"string"},"users":{"description":"The info of the users.","items":{"$ref":"#/components/schemas/UserInfo"},"type":"array"}},"type":"object"},"GetOobConfirmationCodeResponse":{"description":"Response of getting a code for user confirmation (reset password, change email etc.).","properties":{"email":{"description":"The email address that the email is sent to.","type":"string"},"kind":{"default":"identitytoolkit#GetOobConfirmationCodeResponse","description":"The fixed string \"identitytoolkit#GetOobConfirmationCodeResponse\".","type":"string"},"oobCode":{"description":"The code to be send to the user.","type":"string"}},"type":"object"},"GetRecaptchaParamResponse":{"description":"Response of getting recaptcha param.","properties":{"kind":{"default":"identitytoolkit#GetRecaptchaParamResponse","description":"The fixed string \"identitytoolkit#GetRecaptchaParamResponse\".","type":"string"},"recaptchaSiteKey":{"description":"Site key registered at recaptcha.","type":"string"},"recaptchaStoken":{"description":"The stoken field for the recaptcha widget, used to request captcha challenge.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyCreateAuthUriRequest":{"description":"Request to get the IDP authentication URL.","properties":{"appId":{"description":"The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.","type":"string"},"authFlowType":{"description":"Explicitly specify the auth flow type. Currently only support \"CODE_FLOW\" type. The field is only used for Google provider.","type":"string"},"clientId":{"description":"The relying party OAuth client ID.","type":"string"},"context":{"description":"The opaque value used by the client to maintain context info between the authentication request and the IDP callback.","type":"string"},"continueUri":{"description":"The URI to which the IDP redirects the user after the federated login flow.","type":"string"},"customParameter":{"additionalProperties":{"description":"The customized query parameter.","type":"string"},"description":"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.","type":"object"},"hostedDomain":{"description":"The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.","type":"string"},"identifier":{"description":"The email or federated ID of the user.","type":"string"},"oauthConsumerKey":{"description":"The developer's consumer key for OpenId OAuth Extension","type":"string"},"oauthScope":{"description":"Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant","type":"string"},"openidRealm":{"description":"Optional realm for OpenID protocol. The sub string \"scheme://domain:port\" of the param \"continueUri\" is used if this is not set.","type":"string"},"otaApp":{"description":"The native app package for OTA installation.","type":"string"},"providerId":{"description":"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.","type":"string"},"sessionId":{"description":"The session_id passed by client.","type":"string"},"tenantId":{"description":"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.","type":"string"},"tenantProjectNumber":{"description":"Tenant project number to be used for idp discovery.","format":"uint64","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyDeleteAccountRequest":{"description":"Request to delete account.","properties":{"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"idToken":{"description":"The GITKit token or STS id token of the authenticated user.","type":"string"},"localId":{"description":"The local ID of the user.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyDownloadAccountRequest":{"description":"Request to download user account in batch.","properties":{"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"maxResults":{"description":"The max number of results to return in the response.","format":"uint32","type":"integer"},"nextPageToken":{"description":"The token for the next page. This should be taken from the previous response.","type":"string"},"targetProjectId":{"description":"Specify which project (field value is actually project id) to operate. Only used when provided credential.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyEmailLinkSigninRequest":{"description":"Request to sign in with email.","properties":{"email":{"description":"The email address of the user.","type":"string"},"idToken":{"description":"Token for linking flow.","type":"string"},"oobCode":{"description":"The confirmation code.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyGetAccountInfoRequest":{"description":"Request to get the account information.","properties":{"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"email":{"description":"The list of emails of the users to inquiry.","items":{"type":"string"},"type":"array"},"idToken":{"description":"The GITKit token of the authenticated user.","type":"string"},"localId":{"description":"The list of local ID's of the users to inquiry.","items":{"type":"string"},"type":"array"},"phoneNumber":{"description":"Privileged caller can query users by specified phone number.","items":{"type":"string"},"type":"array"}},"type":"object"},"IdentitytoolkitRelyingpartyGetProjectConfigResponse":{"description":"Response of getting the project configuration.","properties":{"allowPasswordUser":{"description":"Whether to allow password user sign in or sign up.","type":"boolean"},"apiKey":{"description":"Browser API key, needed when making http request to Apiary.","type":"string"},"authorizedDomains":{"description":"Authorized domains.","items":{"type":"string"},"type":"array"},"changeEmailTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"dynamicLinksDomain":{"type":"string"},"enableAnonymousUser":{"description":"Whether anonymous user is enabled.","type":"boolean"},"idpConfig":{"description":"OAuth2 provider configuration.","items":{"$ref":"#/components/schemas/IdpConfig"},"type":"array"},"legacyResetPasswordTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"projectId":{"description":"Project ID of the relying party.","type":"string"},"resetPasswordTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"useEmailSending":{"description":"Whether to use email sending provided by Firebear.","type":"boolean"},"verifyEmailTemplate":{"$ref":"#/components/schemas/EmailTemplate"}},"type":"object"},"IdentitytoolkitRelyingpartyGetPublicKeysResponse":{"additionalProperties":{"type":"string"},"description":"Respone of getting public keys.","type":"object"},"IdentitytoolkitRelyingpartyResetPasswordRequest":{"description":"Request to reset the password.","properties":{"email":{"description":"The email address of the user.","type":"string"},"newPassword":{"description":"The new password inputted by the user.","type":"string"},"oldPassword":{"description":"The old password inputted by the user.","type":"string"},"oobCode":{"description":"The confirmation code.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySendVerificationCodeRequest":{"description":"Request for Identitytoolkit-SendVerificationCode","properties":{"iosReceipt":{"description":"Receipt of successful app token validation with APNS.","type":"string"},"iosSecret":{"description":"Secret delivered to iOS app via APNS.","type":"string"},"phoneNumber":{"description":"The phone number to send the verification code to in E.164 format.","type":"string"},"recaptchaToken":{"description":"Recaptcha solution.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySendVerificationCodeResponse":{"description":"Response for Identitytoolkit-SendVerificationCode","properties":{"sessionInfo":{"description":"Encrypted session information","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySetAccountInfoRequest":{"description":"Request to set the account information.","properties":{"captchaChallenge":{"description":"The captcha challenge.","type":"string"},"captchaResponse":{"description":"Response to the captcha.","type":"string"},"createdAt":{"description":"The timestamp when the account is created.","format":"int64","type":"string"},"customAttributes":{"description":"The custom attributes to be set in the user's id token.","type":"string"},"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"deleteAttribute":{"description":"The attributes users request to delete.","items":{"type":"string"},"type":"array"},"deleteProvider":{"description":"The IDPs the user request to delete.","items":{"type":"string"},"type":"array"},"disableUser":{"description":"Whether to disable the user.","type":"boolean"},"displayName":{"description":"The name of the user.","type":"string"},"email":{"description":"The email of the user.","type":"string"},"emailVerified":{"description":"Mark the email as verified or not.","type":"boolean"},"idToken":{"description":"The GITKit token of the authenticated user.","type":"string"},"instanceId":{"description":"Instance id token of the app.","type":"string"},"lastLoginAt":{"description":"Last login timestamp.","format":"int64","type":"string"},"localId":{"description":"The local ID of the user.","type":"string"},"oobCode":{"description":"The out-of-band code of the change email request.","type":"string"},"password":{"description":"The new password of the user.","type":"string"},"phoneNumber":{"description":"Privileged caller can update user with specified phone number.","type":"string"},"photoUrl":{"description":"The photo url of the user.","type":"string"},"provider":{"description":"The associated IDPs of the user.","items":{"type":"string"},"type":"array"},"returnSecureToken":{"description":"Whether return sts id token and refresh token instead of gitkit token.","type":"boolean"},"upgradeToFederatedLogin":{"description":"Mark the user to upgrade to federated login.","type":"boolean"},"validSince":{"description":"Timestamp in seconds for valid login token.","format":"int64","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySetProjectConfigRequest":{"description":"Request to set the project configuration.","properties":{"allowPasswordUser":{"description":"Whether to allow password user sign in or sign up.","type":"boolean"},"apiKey":{"description":"Browser API key, needed when making http request to Apiary.","type":"string"},"authorizedDomains":{"description":"Authorized domains for widget redirect.","items":{"type":"string"},"type":"array"},"changeEmailTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"enableAnonymousUser":{"description":"Whether to enable anonymous user.","type":"boolean"},"idpConfig":{"description":"Oauth2 provider configuration.","items":{"$ref":"#/components/schemas/IdpConfig"},"type":"array"},"legacyResetPasswordTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"resetPasswordTemplate":{"$ref":"#/components/schemas/EmailTemplate"},"useEmailSending":{"description":"Whether to use email sending provided by Firebear.","type":"boolean"},"verifyEmailTemplate":{"$ref":"#/components/schemas/EmailTemplate"}},"type":"object"},"IdentitytoolkitRelyingpartySetProjectConfigResponse":{"description":"Response of setting the project configuration.","properties":{"projectId":{"description":"Project ID of the relying party.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySignOutUserRequest":{"description":"Request to sign out user.","properties":{"instanceId":{"description":"Instance id token of the app.","type":"string"},"localId":{"description":"The local ID of the user.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySignOutUserResponse":{"description":"Response of signing out user.","properties":{"localId":{"description":"The local ID of the user.","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartySignupNewUserRequest":{"description":"Request to signup new user, create anonymous user or anonymous user reauth.","properties":{"captchaChallenge":{"description":"The captcha challenge.","type":"string"},"captchaResponse":{"description":"Response to the captcha.","type":"string"},"disabled":{"description":"Whether to disable the user. Only can be used by service account.","type":"boolean"},"displayName":{"description":"The name of the user.","type":"string"},"email":{"description":"The email of the user.","type":"string"},"emailVerified":{"description":"Mark the email as verified or not. Only can be used by service account.","type":"boolean"},"idToken":{"description":"The GITKit token of the authenticated user.","type":"string"},"instanceId":{"description":"Instance id token of the app.","type":"string"},"localId":{"description":"Privileged caller can create user with specified user id.","type":"string"},"password":{"description":"The new password of the user.","type":"string"},"phoneNumber":{"description":"Privileged caller can create user with specified phone number.","type":"string"},"photoUrl":{"description":"The photo url of the user.","type":"string"},"tenantId":{"description":"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.","type":"string"},"tenantProjectNumber":{"description":"Tenant project number to be used for idp discovery.","format":"uint64","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyUploadAccountRequest":{"description":"Request to upload user account in batch.","properties":{"allowOverwrite":{"description":"Whether allow overwrite existing account when user local_id exists.","type":"boolean"},"blockSize":{"format":"int32","type":"integer"},"cpuMemCost":{"description":"The following 4 fields are for standard scrypt algorithm.","format":"int32","type":"integer"},"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"dkLen":{"format":"int32","type":"integer"},"hashAlgorithm":{"description":"The password hash algorithm.","type":"string"},"memoryCost":{"description":"Memory cost for hash calculation. Used by scrypt similar algorithms.","format":"int32","type":"integer"},"parallelization":{"format":"int32","type":"integer"},"rounds":{"description":"Rounds for hash calculation. Used by scrypt and similar algorithms.","format":"int32","type":"integer"},"saltSeparator":{"description":"The salt separator.","format":"byte","type":"string"},"sanityCheck":{"description":"If true, backend will do sanity check(including duplicate email and federated id) when uploading account.","type":"boolean"},"signerKey":{"description":"The key for to hash the password.","format":"byte","type":"string"},"targetProjectId":{"description":"Specify which project (field value is actually project id) to operate. Only used when provided credential.","type":"string"},"users":{"description":"The account info to be stored.","items":{"$ref":"#/components/schemas/UserInfo"},"type":"array"}},"type":"object"},"IdentitytoolkitRelyingpartyVerifyAssertionRequest":{"description":"Request to verify the IDP assertion.","properties":{"autoCreate":{"description":"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.","type":"boolean"},"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"idToken":{"description":"The GITKit token of the authenticated user.","type":"string"},"instanceId":{"description":"Instance id token of the app.","type":"string"},"pendingIdToken":{"description":"The GITKit token for the non-trusted IDP pending to be confirmed by the user.","type":"string"},"postBody":{"description":"The post body if the request is a HTTP POST.","type":"string"},"requestUri":{"description":"The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.","type":"string"},"returnIdpCredential":{"description":"Whether return 200 and IDP credential rather than throw exception when federated id is already linked.","type":"boolean"},"returnRefreshToken":{"description":"Whether to return refresh tokens.","type":"boolean"},"returnSecureToken":{"description":"Whether return sts id token and refresh token instead of gitkit token.","type":"boolean"},"sessionId":{"description":"Session ID, which should match the one in previous createAuthUri request.","type":"string"},"tenantId":{"description":"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.","type":"string"},"tenantProjectNumber":{"description":"Tenant project number to be used for idp discovery.","format":"uint64","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyVerifyCustomTokenRequest":{"description":"Request to verify a custom token","properties":{"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"instanceId":{"description":"Instance id token of the app.","type":"string"},"returnSecureToken":{"description":"Whether return sts id token and refresh token instead of gitkit token.","type":"boolean"},"token":{"description":"The custom token to verify","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyVerifyPasswordRequest":{"description":"Request to verify the password.","properties":{"captchaChallenge":{"description":"The captcha challenge.","type":"string"},"captchaResponse":{"description":"Response to the captcha.","type":"string"},"delegatedProjectNumber":{"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.","format":"int64","type":"string"},"email":{"description":"The email of the user.","type":"string"},"idToken":{"description":"The GITKit token of the authenticated user.","type":"string"},"instanceId":{"description":"Instance id token of the app.","type":"string"},"password":{"description":"The password inputed by the user.","type":"string"},"pendingIdToken":{"description":"The GITKit token for the non-trusted IDP, which is to be confirmed by the user.","type":"string"},"returnSecureToken":{"description":"Whether return sts id token and refresh token instead of gitkit token.","type":"boolean"},"tenantId":{"description":"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.","type":"string"},"tenantProjectNumber":{"description":"Tenant project number to be used for idp discovery.","format":"uint64","type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest":{"description":"Request for Identitytoolkit-VerifyPhoneNumber","properties":{"code":{"type":"string"},"idToken":{"type":"string"},"operation":{"type":"string"},"phoneNumber":{"type":"string"},"sessionInfo":{"description":"The session info previously returned by IdentityToolkit-SendVerificationCode.","type":"string"},"temporaryProof":{"type":"string"},"verificationProof":{"type":"string"}},"type":"object"},"IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse":{"description":"Response for Identitytoolkit-VerifyPhoneNumber","properties":{"expiresIn":{"format":"int64","type":"string"},"idToken":{"type":"string"},"isNewUser":{"type":"boolean"},"localId":{"type":"string"},"phoneNumber":{"type":"string"},"refreshToken":{"type":"string"},"temporaryProof":{"type":"string"},"temporaryProofExpiresIn":{"format":"int64","type":"string"},"verificationProof":{"type":"string"},"verificationProofExpiresIn":{"format":"int64","type":"string"}},"type":"object"},"IdpConfig":{"description":"Template for a single idp configuration.","properties":{"clientId":{"description":"OAuth2 client ID.","type":"string"},"enabled":{"description":"Whether this IDP is enabled.","type":"boolean"},"experimentPercent":{"description":"Percent of users who will be prompted/redirected federated login for this IDP.","format":"int32","type":"integer"},"provider":{"description":"OAuth2 provider.","type":"string"},"secret":{"description":"OAuth2 client secret.","type":"string"},"whitelistedAudiences":{"description":"Whitelisted client IDs for audience check.","items":{"type":"string"},"type":"array"}},"type":"object"},"Relyingparty":{"description":"Request of getting a code for user confirmation (reset password, change email etc.)","properties":{"androidInstallApp":{"description":"whether or not to install the android app on the device where the link is opened","type":"boolean"},"androidMinimumVersion":{"description":"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","type":"string"},"androidPackageName":{"description":"android package name of the android app to handle the action code","type":"string"},"canHandleCodeInApp":{"description":"whether or not the app can handle the oob code without first going to web","type":"boolean"},"captchaResp":{"description":"The recaptcha response from the user.","type":"string"},"challenge":{"description":"The recaptcha challenge presented to the user.","type":"string"},"continueUrl":{"description":"The url to continue to the Gitkit app","type":"string"},"email":{"description":"The email of the user.","type":"string"},"iOSAppStoreId":{"description":"iOS app store id to download the app if it's not already installed","type":"string"},"iOSBundleId":{"description":"the iOS bundle id of iOS app to handle the action code","type":"string"},"idToken":{"description":"The user's Gitkit login token for email change.","type":"string"},"kind":{"default":"identitytoolkit#relyingparty","description":"The fixed string \"identitytoolkit#relyingparty\".","type":"string"},"newEmail":{"description":"The new email if the code is for email change.","type":"string"},"requestType":{"description":"The request type.","type":"string"},"userIp":{"description":"The IP address of the user.","type":"string"}},"type":"object"},"ResetPasswordResponse":{"description":"Response of resetting the password.","properties":{"email":{"description":"The user's email. If the out-of-band code is for email recovery, the user's original email.","type":"string"},"kind":{"default":"identitytoolkit#ResetPasswordResponse","description":"The fixed string \"identitytoolkit#ResetPasswordResponse\".","type":"string"},"newEmail":{"description":"If the out-of-band code is for email recovery, the user's new email.","type":"string"},"requestType":{"description":"The request type.","type":"string"}},"type":"object"},"SetAccountInfoResponse":{"description":"Respone of setting the account information.","properties":{"displayName":{"description":"The name of the user.","type":"string"},"email":{"description":"The email of the user.","type":"string"},"emailVerified":{"description":"If email has been verified.","type":"boolean"},"expiresIn":{"description":"If idToken is STS id token, then this field will be expiration time of STS id token in seconds.","format":"int64","type":"string"},"idToken":{"description":"The Gitkit id token to login the newly sign up user.","type":"string"},"kind":{"default":"identitytoolkit#SetAccountInfoResponse","description":"The fixed string \"identitytoolkit#SetAccountInfoResponse\".","type":"string"},"localId":{"description":"The local ID of the user.","type":"string"},"newEmail":{"description":"The new email the user attempts to change to.","type":"string"},"passwordHash":{"description":"The user's hashed password.","format":"byte","type":"string"},"photoUrl":{"description":"The photo url of the user.","type":"string"},"providerUserInfo":{"description":"The user's profiles at the associated IdPs.","items":{"properties":{"displayName":{"description":"The user's display name at the IDP.","type":"string"},"federatedId":{"description":"User's identifier at IDP.","type":"string"},"photoUrl":{"description":"The user's photo url at the IDP.","type":"string"},"providerId":{"description":"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.","type":"string"}},"type":"object"},"type":"array"},"refreshToken":{"description":"If idToken is STS id token, then this field will be refresh token.","type":"string"}},"type":"object"},"SignupNewUserResponse":{"description":"Response of signing up new user, creating anonymous user or anonymous user reauth.","properties":{"displayName":{"description":"The name of the user.","type":"string"},"email":{"description":"The email of the user.","type":"string"},"expiresIn":{"description":"If idToken is STS id token, then this field will be expiration time of STS id token in seconds.","format":"int64","type":"string"},"idToken":{"description":"The Gitkit id token to login the newly sign up user.","type":"string"},"kind":{"default":"identitytoolkit#SignupNewUserResponse","description":"The fixed string \"identitytoolkit#SignupNewUserResponse\".","type":"string"},"localId":{"description":"The RP local ID of the user.","type":"string"},"refreshToken":{"description":"If idToken is STS id token, then this field will be refresh token.","type":"string"}},"type":"object"},"UploadAccountResponse":{"description":"Respone of uploading accounts in batch.","properties":{"error":{"description":"The error encountered while processing the account info.","items":{"properties":{"index":{"description":"The index of the malformed account, starting from 0.","format":"int32","type":"integer"},"message":{"description":"Detailed error message for the account info.","type":"string"}},"type":"object"},"type":"array"},"kind":{"default":"identitytoolkit#UploadAccountResponse","description":"The fixed string \"identitytoolkit#UploadAccountResponse\".","type":"string"}},"type":"object"},"UserInfo":{"description":"Template for an individual account info.","properties":{"createdAt":{"description":"User creation timestamp.","format":"int64","ty