{ "ownerDomain": "google.com", "etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/taa97NuhcHSAt0fUktvGBcH-OqE\"", "protocol": "rest", "name": "identitytoolkit", "servicePath": "identitytoolkit/v3/relyingparty/", "revision": "20180723", "basePath": "/identitytoolkit/v3/relyingparty/", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, "id": "identitytoolkit:v3", "rootUrl": "https://www.googleapis.com/", "discoveryVersion": "v1", "ownerName": "Google", "schemas": { "IdentitytoolkitRelyingpartySetProjectConfigResponse": { "type": "object", "id": "IdentitytoolkitRelyingpartySetProjectConfigResponse", "description": "Response of setting the project configuration.", "properties": { "projectId": { "description": "Project ID of the relying party.", "type": "string" } } }, "VerifyCustomTokenResponse": { "properties": { "idToken": { "type": "string", "description": "The GITKit token for authenticated user." }, "kind": { "description": "The fixed string \"identitytoolkit#VerifyCustomTokenResponse\".", "type": "string", "default": "identitytoolkit#VerifyCustomTokenResponse" }, "expiresIn": { "type": "string", "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.", "format": "int64" }, "refreshToken": { "type": "string", "description": "If idToken is STS id token, then this field will be refresh token." }, "isNewUser": { "type": "boolean", "description": "True if it's a new user sign-in, false if it's a returning user." } }, "id": "VerifyCustomTokenResponse", "description": "Response from verifying a custom token", "type": "object" }, "IdentitytoolkitRelyingpartyGetProjectConfigResponse": { "id": "IdentitytoolkitRelyingpartyGetProjectConfigResponse", "description": "Response of getting the project configuration.", "type": "object", "properties": { "resetPasswordTemplate": { "$ref": "EmailTemplate", "description": "Reset password email template." }, "legacyResetPasswordTemplate": { "$ref": "EmailTemplate", "description": "Legacy reset password email template." }, "authorizedDomains": { "type": "array", "description": "Authorized domains.", "items": { "type": "string" } }, "apiKey": { "type": "string", "description": "Browser API key, needed when making http request to Apiary." }, "projectId": { "description": "Project ID of the relying party.", "type": "string" }, "enableAnonymousUser": { "description": "Whether anonymous user is enabled.", "type": "boolean" }, "allowPasswordUser": { "type": "boolean", "description": "Whether to allow password user sign in or sign up." }, "dynamicLinksDomain": { "type": "string" }, "changeEmailTemplate": { "$ref": "EmailTemplate", "description": "Change email template." }, "idpConfig": { "items": { "$ref": "IdpConfig" }, "description": "OAuth2 provider configuration.", "type": "array" }, "verifyEmailTemplate": { "$ref": "EmailTemplate", "description": "Verify email template." }, "useEmailSending": { "type": "boolean", "description": "Whether to use email sending provided by Firebear." } } }, "IdentitytoolkitRelyingpartyDeleteAccountRequest": { "id": "IdentitytoolkitRelyingpartyDeleteAccountRequest", "description": "Request to delete account.", "type": "object", "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": { "type": "string", "description": "The local ID of the user." } } }, "IdentitytoolkitRelyingpartyVerifyPasswordRequest": { "properties": { "returnSecureToken": { "description": "Whether return sts id token and refresh token instead of gitkit token.", "type": "boolean" }, "email": { "description": "The email of the user.", "type": "string" }, "password": { "description": "The password inputed by the user.", "type": "string" }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "idToken": { "type": "string", "description": "The GITKit token of the authenticated user." }, "pendingIdToken": { "type": "string", "description": "The GITKit token for the non-trusted IDP, which is to be confirmed by the user." }, "tenantProjectNumber": { "type": "string", "description": "Tenant project number to be used for idp discovery.", "format": "uint64" }, "captchaResponse": { "type": "string", "description": "Response to the captcha." }, "captchaChallenge": { "description": "The captcha challenge.", "type": "string" }, "instanceId": { "type": "string", "description": "Instance id token of the app." }, "tenantId": { "type": "string", "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": "object", "id": "IdentitytoolkitRelyingpartyVerifyPasswordRequest", "description": "Request to verify the password." }, "IdentitytoolkitRelyingpartyGetPublicKeysResponse": { "additionalProperties": { "type": "string" }, "id": "IdentitytoolkitRelyingpartyGetPublicKeysResponse", "description": "Respone of getting public keys.", "type": "object" }, "UploadAccountResponse": { "id": "UploadAccountResponse", "description": "Respone of uploading accounts in batch.", "type": "object", "properties": { "kind": { "type": "string", "default": "identitytoolkit#UploadAccountResponse", "description": "The fixed string \"identitytoolkit#UploadAccountResponse\"." }, "error": { "description": "The error encountered while processing the account info.", "type": "array", "items": { "properties": { "index": { "type": "integer", "description": "The index of the malformed account, starting from 0.", "format": "int32" }, "message": { "type": "string", "description": "Detailed error message for the account info." } }, "type": "object" } } } }, "DeleteAccountResponse": { "id": "DeleteAccountResponse", "description": "Respone of deleting account.", "type": "object", "properties": { "kind": { "type": "string", "default": "identitytoolkit#DeleteAccountResponse", "description": "The fixed string \"identitytoolkit#DeleteAccountResponse\"." } } }, "CreateAuthUriResponse": { "properties": { "captchaRequired": { "description": "True if captcha is required.", "type": "boolean" }, "signinMethods": { "type": "array", "description": "All sign-in methods this user has used.", "items": { "type": "string" } }, "sessionId": { "description": "Session ID which should be passed in the following verifyAssertion request.", "type": "string" }, "allProviders": { "items": { "type": "string" }, "description": "all providers the user has once used to do federated login", "type": "array" }, "kind": { "type": "string", "default": "identitytoolkit#CreateAuthUriResponse", "description": "The fixed string identitytoolkit#CreateAuthUriResponse\"." }, "providerId": { "type": "string", "description": "The provider ID of the auth URI." }, "registered": { "type": "boolean", "description": "Whether the user is registered if the identifier is an email." }, "authUri": { "type": "string", "description": "The URI used by the IDP to authenticate the user." }, "forExistingProvider": { "type": "boolean", "description": "True if the authUri is for user's existing provider." } }, "type": "object", "id": "CreateAuthUriResponse", "description": "Response of creating the IDP authentication URL." }, "IdentitytoolkitRelyingpartyCreateAuthUriRequest": { "id": "IdentitytoolkitRelyingpartyCreateAuthUriRequest", "description": "Request to get the IDP authentication URL.", "type": "object", "properties": { "oauthConsumerKey": { "description": "The developer's consumer key for OpenId OAuth Extension", "type": "string" }, "openidRealm": { "type": "string", "description": "Optional realm for OpenID protocol. The sub string \"scheme://domain:port\" of the param \"continueUri\" is used if this is not set." }, "sessionId": { "description": "The session_id passed by client.", "type": "string" }, "appId": { "description": "The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.", "type": "string" }, "hostedDomain": { "type": "string", "description": "The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts." }, "clientId": { "type": "string", "description": "The relying party OAuth client ID." }, "oauthScope": { "type": "string", "description": "Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant" }, "authFlowType": { "type": "string", "description": "Explicitly specify the auth flow type. Currently only support \"CODE_FLOW\" type. The field is only used for Google provider." }, "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" }, "identifier": { "type": "string", "description": "The email or federated ID of the user." }, "continueUri": { "type": "string", "description": "The URI to which the IDP redirects the user after the federated login flow." }, "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" }, "tenantProjectNumber": { "description": "Tenant project number to be used for idp discovery.", "format": "uint64", "type": "string" }, "context": { "type": "string", "description": "The opaque value used by the client to maintain context info between the authentication request and the IDP callback." }, "otaApp": { "type": "string", "description": "The native app package for OTA installation." }, "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" } } }, "IdentitytoolkitRelyingpartyResetPasswordRequest": { "id": "IdentitytoolkitRelyingpartyResetPasswordRequest", "description": "Request to reset the password.", "type": "object", "properties": { "oldPassword": { "type": "string", "description": "The old password inputted by the user." }, "oobCode": { "type": "string", "description": "The confirmation code." }, "newPassword": { "type": "string", "description": "The new password inputted by the user." }, "email": { "type": "string", "description": "The email address of the user." } } }, "DownloadAccountResponse": { "properties": { "kind": { "description": "The fixed string \"identitytoolkit#DownloadAccountResponse\".", "type": "string", "default": "identitytoolkit#DownloadAccountResponse" }, "nextPageToken": { "description": "The next page token. To be used in a subsequent request to return the next page of results.", "type": "string" }, "users": { "type": "array", "description": "The user accounts data.", "items": { "$ref": "UserInfo" } } }, "type": "object", "id": "DownloadAccountResponse", "description": "Response of downloading accounts in batch." }, "GetRecaptchaParamResponse": { "properties": { "recaptchaSiteKey": { "type": "string", "description": "Site key registered at recaptcha." }, "kind": { "description": "The fixed string \"identitytoolkit#GetRecaptchaParamResponse\".", "type": "string", "default": "identitytoolkit#GetRecaptchaParamResponse" }, "recaptchaStoken": { "type": "string", "description": "The stoken field for the recaptcha widget, used to request captcha challenge." } }, "id": "GetRecaptchaParamResponse", "description": "Response of getting recaptcha param.", "type": "object" }, "IdentitytoolkitRelyingpartyGetAccountInfoRequest": { "type": "object", "id": "IdentitytoolkitRelyingpartyGetAccountInfoRequest", "description": "Request to get the account information.", "properties": { "phoneNumber": { "description": "Privileged caller can query users by specified phone number.", "type": "array", "items": { "type": "string" } }, "delegatedProjectNumber": { "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64", "type": "string" }, "idToken": { "type": "string", "description": "The GITKit token of the authenticated user." }, "localId": { "type": "array", "description": "The list of local ID's of the users to inquiry.", "items": { "type": "string" } }, "email": { "description": "The list of emails of the users to inquiry.", "type": "array", "items": { "type": "string" } } } }, "EmailLinkSigninResponse": { "properties": { "email": { "description": "The user's email.", "type": "string" }, "isNewUser": { "description": "Whether the user is new.", "type": "boolean" }, "idToken": { "description": "The STS id token to login the newly signed in user.", "type": "string" }, "kind": { "description": "The fixed string \"identitytoolkit#EmailLinkSigninResponse\".", "type": "string", "default": "identitytoolkit#EmailLinkSigninResponse" }, "localId": { "type": "string", "description": "The RP local ID of the user." }, "expiresIn": { "description": "Expiration time of STS id token in seconds.", "format": "int64", "type": "string" }, "refreshToken": { "type": "string", "description": "The refresh token for the signed in user." } }, "type": "object", "id": "EmailLinkSigninResponse", "description": "Response of email signIn." }, "IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse": { "type": "object", "id": "IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse", "description": "Response for Identitytoolkit-VerifyPhoneNumber", "properties": { "verificationProofExpiresIn": { "format": "int64", "type": "string" }, "idToken": { "type": "string" }, "phoneNumber": { "type": "string" }, "isNewUser": { "type": "boolean" }, "temporaryProofExpiresIn": { "format": "int64", "type": "string" }, "expiresIn": { "format": "int64", "type": "string" }, "refreshToken": { "type": "string" }, "localId": { "type": "string" }, "verificationProof": { "type": "string" }, "temporaryProof": { "type": "string" } } }, "IdentitytoolkitRelyingpartyUploadAccountRequest": { "properties": { "dkLen": { "format": "int32", "type": "integer" }, "users": { "type": "array", "description": "The account info to be stored.", "items": { "$ref": "UserInfo" } }, "saltSeparator": { "type": "string", "description": "The salt separator.", "format": "byte" }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "sanityCheck": { "description": "If true, backend will do sanity check(including duplicate email and federated id) when uploading account.", "type": "boolean" }, "blockSize": { "format": "int32", "type": "integer" }, "allowOverwrite": { "description": "Whether allow overwrite existing account when user local_id exists.", "type": "boolean" }, "cpuMemCost": { "description": "The following 4 fields are for standard scrypt algorithm.", "format": "int32", "type": "integer" }, "rounds": { "description": "Rounds for hash calculation. Used by scrypt and similar algorithms.", "format": "int32", "type": "integer" }, "memoryCost": { "type": "integer", "description": "Memory cost for hash calculation. Used by scrypt similar algorithms.", "format": "int32" }, "parallelization": { "format": "int32", "type": "integer" }, "hashAlgorithm": { "type": "string", "description": "The password hash algorithm." }, "targetProjectId": { "type": "string", "description": "Specify which project (field value is actually project id) to operate. Only used when provided credential." }, "signerKey": { "type": "string", "description": "The key for to hash the password.", "format": "byte" } }, "id": "IdentitytoolkitRelyingpartyUploadAccountRequest", "description": "Request to upload user account in batch.", "type": "object" }, "UserInfo": { "type": "object", "id": "UserInfo", "description": "Template for an individual account info.", "properties": { "photoUrl": { "description": "The URL of the user profile photo.", "type": "string" }, "displayName": { "type": "string", "description": "The name of the user." }, "phoneNumber": { "description": "User's phone number.", "type": "string" }, "providerUserInfo": { "description": "The IDP of the user.", "type": "array", "items": { "properties": { "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" }, "photoUrl": { "type": "string", "description": "The user's photo url at the IDP." }, "screenName": { "type": "string", "description": "User's screen name at Twitter or login name at Github." }, "displayName": { "description": "The user's display name at the IDP.", "type": "string" }, "phoneNumber": { "type": "string", "description": "User's phone number." }, "rawId": { "description": "User's raw identifier directly returned from IDP.", "type": "string" }, "email": { "type": "string", "description": "User's email at IDP." }, "federatedId": { "description": "User's identifier at IDP.", "type": "string" } }, "type": "object" } }, "screenName": { "type": "string", "description": "User's screen name at Twitter or login name at Github." }, "email": { "description": "The email of the user.", "type": "string" }, "localId": { "description": "The local ID of the user.", "type": "string" }, "passwordHash": { "description": "The user's hashed password.", "format": "byte", "type": "string" }, "customAttributes": { "type": "string", "description": "The custom attributes to be set in the user's id token." }, "validSince": { "type": "string", "description": "Timestamp in seconds for valid login token.", "format": "int64" }, "passwordUpdatedAt": { "description": "The timestamp when the password was last updated.", "format": "double", "type": "number" }, "lastLoginAt": { "description": "last login timestamp.", "format": "int64", "type": "string" }, "version": { "description": "Version of the user's password.", "format": "int32", "type": "integer" }, "emailVerified": { "type": "boolean", "description": "Whether the email has been verified." }, "customAuth": { "description": "Whether the user is authenticated by the developer.", "type": "boolean" }, "rawPassword": { "type": "string", "description": "The user's plain text password." }, "disabled": { "description": "Whether the user is disabled.", "type": "boolean" }, "createdAt": { "type": "string", "description": "User creation timestamp.", "format": "int64" }, "salt": { "type": "string", "description": "The user's password salt.", "format": "byte" } } }, "GetOobConfirmationCodeResponse": { "type": "object", "id": "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": { "description": "The fixed string \"identitytoolkit#GetOobConfirmationCodeResponse\".", "type": "string", "default": "identitytoolkit#GetOobConfirmationCodeResponse" }, "oobCode": { "type": "string", "description": "The code to be send to the user." } } }, "IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest": { "type": "object", "id": "IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest", "description": "Request for Identitytoolkit-VerifyPhoneNumber", "properties": { "operation": { "type": "string" }, "phoneNumber": { "type": "string" }, "verificationProof": { "type": "string" }, "sessionInfo": { "type": "string", "description": "The session info previously returned by IdentityToolkit-SendVerificationCode." }, "idToken": { "type": "string" }, "temporaryProof": { "type": "string" }, "code": { "type": "string" } } }, "SignupNewUserResponse": { "id": "SignupNewUserResponse", "description": "Response of signing up new user, creating anonymous user or anonymous user reauth.", "type": "object", "properties": { "expiresIn": { "type": "string", "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.", "format": "int64" }, "refreshToken": { "type": "string", "description": "If idToken is STS id token, then this field will be refresh token." }, "idToken": { "description": "The Gitkit id token to login the newly sign up user.", "type": "string" }, "kind": { "description": "The fixed string \"identitytoolkit#SignupNewUserResponse\".", "type": "string", "default": "identitytoolkit#SignupNewUserResponse" }, "localId": { "type": "string", "description": "The RP local ID of the user." }, "displayName": { "type": "string", "description": "The name of the user." }, "email": { "type": "string", "description": "The email of the user." } } }, "VerifyAssertionResponse": { "properties": { "oauthAuthorizationCode": { "type": "string", "description": "The OAuth2 authorization code." }, "localId": { "type": "string", "description": "The RP local ID if it's already been mapped to the IdP account identified by the federated ID." }, "federatedId": { "description": "The unique ID identifies the IdP account.", "type": "string" }, "displayName": { "description": "The display name of the user.", "type": "string" }, "screenName": { "type": "string", "description": "The screen_name of a Twitter user or the login name at Github." }, "context": { "type": "string", "description": "The opaque value used by the client to maintain context info between the authentication request and the IDP callback." }, "emailRecycled": { "type": "boolean", "description": "It's true if the email is recycled." }, "nickName": { "description": "The nick name of the user.", "type": "string" }, "providerId": { "type": "string", "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. 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." }, "email": { "type": "string", "description": "The email returned by the IdP. NOTE: The federated login user may not own the email." }, "errorMessage": { "description": "Client error code.", "type": "string" }, "timeZone": { "description": "The timezone of the user.", "type": "string" }, "appScheme": { "type": "string", "description": "The custom scheme used by mobile app." }, "firstName": { "description": "The first name of the user.", "type": "string" }, "needEmail": { "description": "Whether need client to supply email to complete the federated login flow.", "type": "boolean" }, "kind": { "type": "string", "default": "identitytoolkit#VerifyAssertionResponse", "description": "The fixed string \"identitytoolkit#VerifyAssertionResponse\"." }, "oauthRequestToken": { "type": "string", "description": "The user approved request token for the OpenID OAuth extension." }, "oauthIdToken": { "description": "The OIDC id token.", "type": "string" }, "action": { "description": "The action code.", "type": "string" }, "lastName": { "description": "The last name of the user.", "type": "string" }, "refreshToken": { "type": "string", "description": "If idToken is STS id token, then this field will be refresh token." }, "rawUserInfo": { "type": "string", "description": "Raw IDP-returned user info." }, "appInstallationUrl": { "type": "string", "description": "URL for OTA app installation." }, "photoUrl": { "description": "The URI of the public accessible profiel picture.", "type": "string" }, "fullName": { "description": "The full name of the user.", "type": "string" }, "needConfirmation": { "description": "Whether the assertion is from a non-trusted IDP and need account linking confirmation.", "type": "boolean" }, "originalEmail": { "type": "string", "description": "The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email." }, "dateOfBirth": { "description": "The birth date of the IdP account.", "type": "string" }, "oauthTokenSecret": { "type": "string", "description": "The OAuth1 access token secret." }, "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" }, "language": { "type": "string", "description": "The language preference of the user." }, "oauthAccessToken": { "description": "The OAuth2 access token.", "type": "string" }, "emailVerified": { "description": "The value is true if the IDP is also the email provider. It means the user owns the email.", "type": "boolean" }, "verifiedProvider": { "type": "array", "description": "When action is 'map', contains the idps which can be used for confirmation.", "items": { "type": "string" } }, "oauthExpireIn": { "type": "integer", "description": "The lifetime in seconds of the OAuth2 access token.", "format": "int32" }, "idToken": { "type": "string", "description": "The ID token." }, "oauthScope": { "description": "The scope for the OpenID OAuth extension.", "type": "string" }, "inputEmail": { "type": "string", "description": "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." }, "isNewUser": { "type": "boolean", "description": "True if it's a new user sign-in, false if it's a returning user." } }, "id": "VerifyAssertionResponse", "description": "Response of verifying the IDP assertion.", "type": "object" }, "IdentitytoolkitRelyingpartySignOutUserResponse": { "type": "object", "id": "IdentitytoolkitRelyingpartySignOutUserResponse", "description": "Response of signing out user.", "properties": { "localId": { "type": "string", "description": "The local ID of the user." } } }, "IdpConfig": { "properties": { "provider": { "type": "string", "description": "OAuth2 provider." }, "whitelistedAudiences": { "type": "array", "description": "Whitelisted client IDs for audience check.", "items": { "type": "string" } }, "secret": { "description": "OAuth2 client secret.", "type": "string" }, "clientId": { "type": "string", "description": "OAuth2 client ID." }, "enabled": { "description": "Whether this IDP is enabled.", "type": "boolean" }, "experimentPercent": { "type": "integer", "description": "Percent of users who will be prompted/redirected federated login for this IDP.", "format": "int32" } }, "type": "object", "id": "IdpConfig", "description": "Template for a single idp configuration." }, "IdentitytoolkitRelyingpartySignupNewUserRequest": { "properties": { "instanceId": { "description": "Instance id token of the app.", "type": "string" }, "disabled": { "type": "boolean", "description": "Whether to disable the user. Only can be used by service account." }, "password": { "description": "The new password of the user.", "type": "string" }, "idToken": { "type": "string", "description": "The GITKit token of the authenticated user." }, "emailVerified": { "description": "Mark the email as verified or not. Only can be used by service account.", "type": "boolean" }, "captchaChallenge": { "type": "string", "description": "The captcha challenge." }, "localId": { "description": "Privileged caller can create user with specified user id.", "type": "string" }, "tenantId": { "type": "string", "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." }, "captchaResponse": { "description": "Response to the captcha.", "type": "string" }, "photoUrl": { "description": "The photo url of the user.", "type": "string" }, "displayName": { "description": "The name of the user.", "type": "string" }, "phoneNumber": { "description": "Privileged caller can create user with specified phone number.", "type": "string" }, "tenantProjectNumber": { "description": "Tenant project number to be used for idp discovery.", "format": "uint64", "type": "string" }, "email": { "description": "The email of the user.", "type": "string" } }, "type": "object", "id": "IdentitytoolkitRelyingpartySignupNewUserRequest", "description": "Request to signup new user, create anonymous user or anonymous user reauth." }, "VerifyPasswordResponse": { "type": "object", "id": "VerifyPasswordResponse", "description": "Request of verifying the password.", "properties": { "email": { "description": "The email returned by the IdP. NOTE: The federated login user may not own the email.", "type": "string" }, "idToken": { "type": "string", "description": "The GITKit token for authenticated user." }, "kind": { "description": "The fixed string \"identitytoolkit#VerifyPasswordResponse\".", "type": "string", "default": "identitytoolkit#VerifyPasswordResponse" }, "registered": { "type": "boolean", "description": "Whether the email is registered." }, "oauthExpireIn": { "type": "integer", "description": "The lifetime in seconds of the OAuth2 access token.", "format": "int32" }, "photoUrl": { "description": "The URI of the user's photo at IdP", "type": "string" }, "displayName": { "description": "The name of the user.", "type": "string" }, "oauthAccessToken": { "description": "The OAuth2 access token.", "type": "string" }, "localId": { "description": "The RP local ID if it's already been mapped to the IdP account identified by the federated ID.", "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" }, "oauthAuthorizationCode": { "description": "The OAuth2 authorization code.", "type": "string" }, "refreshToken": { "description": "If idToken is STS id token, then this field will be refresh token.", "type": "string" } } }, "IdentitytoolkitRelyingpartyVerifyAssertionRequest": { "type": "object", "id": "IdentitytoolkitRelyingpartyVerifyAssertionRequest", "description": "Request to verify the IDP assertion.", "properties": { "instanceId": { "type": "string", "description": "Instance id token of the app." }, "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" }, "sessionId": { "type": "string", "description": "Session ID, which should match the one in previous createAuthUri request." }, "idToken": { "type": "string", "description": "The GITKit token of the authenticated user." }, "requestUri": { "type": "string", "description": "The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP." }, "postBody": { "description": "The post body if the request is a HTTP POST.", "type": "string" }, "returnSecureToken": { "description": "Whether return sts id token and refresh token instead of gitkit token.", "type": "boolean" }, "returnRefreshToken": { "type": "boolean", "description": "Whether to return refresh tokens." }, "returnIdpCredential": { "type": "boolean", "description": "Whether return 200 and IDP credential rather than throw exception when federated id is already linked." }, "tenantId": { "type": "string", "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." }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "pendingIdToken": { "type": "string", "description": "The GITKit token for the non-trusted IDP pending to be confirmed by the user." }, "tenantProjectNumber": { "description": "Tenant project number to be used for idp discovery.", "format": "uint64", "type": "string" } } }, "IdentitytoolkitRelyingpartySendVerificationCodeResponse": { "properties": { "sessionInfo": { "description": "Encrypted session information", "type": "string" } }, "id": "IdentitytoolkitRelyingpartySendVerificationCodeResponse", "description": "Response for Identitytoolkit-SendVerificationCode", "type": "object" }, "IdentitytoolkitRelyingpartySendVerificationCodeRequest": { "id": "IdentitytoolkitRelyingpartySendVerificationCodeRequest", "description": "Request for Identitytoolkit-SendVerificationCode", "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "The phone number to send the verification code to in E.164 format." }, "recaptchaToken": { "type": "string", "description": "Recaptcha solution." }, "iosReceipt": { "description": "Receipt of successful app token validation with APNS.", "type": "string" }, "iosSecret": { "description": "Secret delivered to iOS app via APNS.", "type": "string" } } }, "IdentitytoolkitRelyingpartySetAccountInfoRequest": { "properties": { "captchaResponse": { "type": "string", "description": "Response to the captcha." }, "validSince": { "type": "string", "description": "Timestamp in seconds for valid login token.", "format": "int64" }, "customAttributes": { "description": "The custom attributes to be set in the user's id token.", "type": "string" }, "upgradeToFederatedLogin": { "description": "Mark the user to upgrade to federated login.", "type": "boolean" }, "oobCode": { "description": "The out-of-band code of the change email request.", "type": "string" }, "captchaChallenge": { "type": "string", "description": "The captcha challenge." }, "deleteProvider": { "items": { "type": "string" }, "type": "array", "description": "The IDPs the user request to delete." }, "localId": { "description": "The local ID of the user.", "type": "string" }, "deleteAttribute": { "description": "The attributes users request to delete.", "type": "array", "items": { "type": "string" } }, "disableUser": { "type": "boolean", "description": "Whether to disable the user." }, "email": { "type": "string", "description": "The email of the user." }, "displayName": { "description": "The name 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" }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "createdAt": { "description": "The timestamp when the account is created.", "format": "int64", "type": "string" }, "provider": { "type": "array", "description": "The associated IDPs of the user.", "items": { "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" }, "emailVerified": { "type": "boolean", "description": "Mark the email as verified or not." }, "password": { "description": "The new password of the user.", "type": "string" }, "idToken": { "description": "The GITKit token of the authenticated user.", "type": "string" }, "lastLoginAt": { "description": "Last login timestamp.", "format": "int64", "type": "string" } }, "type": "object", "id": "IdentitytoolkitRelyingpartySetAccountInfoRequest", "description": "Request to set the account information." }, "ResetPasswordResponse": { "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": { "description": "The fixed string \"identitytoolkit#ResetPasswordResponse\".", "type": "string", "default": "identitytoolkit#ResetPasswordResponse" }, "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", "id": "ResetPasswordResponse", "description": "Response of resetting the password." }, "IdentitytoolkitRelyingpartyDownloadAccountRequest": { "properties": { "nextPageToken": { "description": "The token for the next page. This should be taken from the previous response.", "type": "string" }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "maxResults": { "type": "integer", "description": "The max number of results to return in the response.", "format": "uint32" }, "targetProjectId": { "description": "Specify which project (field value is actually project id) to operate. Only used when provided credential.", "type": "string" } }, "type": "object", "id": "IdentitytoolkitRelyingpartyDownloadAccountRequest", "description": "Request to download user account in batch." }, "EmailTemplate": { "properties": { "replyTo": { "description": "Reply-to address.", "type": "string" }, "fromDisplayName": { "description": "From display name.", "type": "string" }, "subject": { "type": "string", "description": "Subject of the email." }, "body": { "description": "Email body.", "type": "string" }, "format": { "type": "string", "description": "Email body format." }, "from": { "type": "string", "description": "From address of the email." } }, "type": "object", "id": "EmailTemplate", "description": "Template for an email template." }, "IdentitytoolkitRelyingpartySetProjectConfigRequest": { "properties": { "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "authorizedDomains": { "items": { "type": "string" }, "description": "Authorized domains for widget redirect.", "type": "array" }, "apiKey": { "description": "Browser API key, needed when making http request to Apiary.", "type": "string" }, "resetPasswordTemplate": { "$ref": "EmailTemplate", "description": "Reset password email template." }, "legacyResetPasswordTemplate": { "$ref": "EmailTemplate", "description": "Legacy reset password email template." }, "changeEmailTemplate": { "$ref": "EmailTemplate", "description": "Change email template." }, "idpConfig": { "description": "Oauth2 provider configuration.", "type": "array", "items": { "$ref": "IdpConfig" } }, "verifyEmailTemplate": { "$ref": "EmailTemplate", "description": "Verify email template." }, "useEmailSending": { "description": "Whether to use email sending provided by Firebear.", "type": "boolean" }, "enableAnonymousUser": { "description": "Whether to enable anonymous user.", "type": "boolean" }, "allowPasswordUser": { "description": "Whether to allow password user sign in or sign up.", "type": "boolean" } }, "type": "object", "id": "IdentitytoolkitRelyingpartySetProjectConfigRequest", "description": "Request to set the project configuration." }, "IdentitytoolkitRelyingpartySignOutUserRequest": { "properties": { "instanceId": { "description": "Instance id token of the app.", "type": "string" }, "localId": { "type": "string", "description": "The local ID of the user." } }, "id": "IdentitytoolkitRelyingpartySignOutUserRequest", "description": "Request to sign out user.", "type": "object" }, "IdentitytoolkitRelyingpartyVerifyCustomTokenRequest": { "properties": { "instanceId": { "description": "Instance id token of the app.", "type": "string" }, "returnSecureToken": { "type": "boolean", "description": "Whether return sts id token and refresh token instead of gitkit token." }, "delegatedProjectNumber": { "type": "string", "description": "GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.", "format": "int64" }, "token": { "description": "The custom token to verify", "type": "string" } }, "id": "IdentitytoolkitRelyingpartyVerifyCustomTokenRequest", "description": "Request to verify a custom token", "type": "object" }, "GetAccountInfoResponse": { "type": "object", "id": "GetAccountInfoResponse", "description": "Response of getting account information.", "properties": { "kind": { "type": "string", "default": "identitytoolkit#GetAccountInfoResponse", "description": "The fixed string \"identitytoolkit#GetAccountInfoResponse\"." }, "users": { "type": "array", "description": "The info of the users.", "items": { "$ref": "UserInfo" } } } }, "SetAccountInfoResponse": { "properties": { "passwordHash": { "description": "The user's hashed password.", "format": "byte", "type": "string" }, "localId": { "type": "string", "description": "The local ID of the user." }, "expiresIn": { "type": "string", "description": "If idToken is STS id token, then this field will be expiration time of STS id token in seconds.", "format": "int64" }, "refreshToken": { "description": "If idToken is STS id token, then this field will be refresh token.", "type": "string" }, "email": { "description": "The email of the user.", "type": "string" }, "newEmail": { "type": "string", "description": "The new email the user attempts to change to." }, "providerUserInfo": { "type": "array", "description": "The user's profiles at the associated IdPs.", "items": { "properties": { "displayName": { "description": "The user's display name at the IDP.", "type": "string" }, "federatedId": { "type": "string", "description": "User's identifier at IDP." }, "photoUrl": { "description": "The user's photo url at the IDP.", "type": "string" }, "providerId": { "type": "string", "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": "object" } }, "displayName": { "description": "The name of the user.", "type": "string" }, "emailVerified": { "description": "If email has been verified.", "type": "boolean" }, "idToken": { "description": "The Gitkit id token to login the newly sign up user.", "type": "string" }, "kind": { "type": "string", "default": "identitytoolkit#SetAccountInfoResponse", "description": "The fixed string \"identitytoolkit#SetAccountInfoResponse\"." }, "photoUrl": { "description": "The photo url of the user.", "type": "string" } }, "id": "SetAccountInfoResponse", "description": "Respone of setting the account information.", "type": "object" }, "IdentitytoolkitRelyingpartyEmailLinkSigninRequest": { "type": "object", "id": "IdentitytoolkitRelyingpartyEmailLinkSigninRequest", "description": "Request to sign in with email.", "properties": { "oobCode": { "description": "The confirmation code.", "type": "string" }, "email": { "description": "The email address of the user.", "type": "string" }, "idToken": { "type": "string", "description": "Token for linking flow." } } }, "Relyingparty": { "properties": { "androidPackageName": { "type": "string", "description": "android package name of the android app to handle the action code" }, "androidMinimumVersion": { "type": "string", "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" }, "email": { "type": "string", "description": "The email of the user." }, "captchaResp": { "type": "string", "description": "The recaptcha response from the user." }, "androidInstallApp": { "type": "boolean", "description": "whether or not to install the android app on the device where the link is opened" }, "canHandleCodeInApp": { "type": "boolean", "description": "whether or not the app can handle the oob code without first going to web" }, "iOSAppStoreId": { "description": "iOS app store id to download the app if it's not already installed", "type": "string" }, "iOSBundleId": { "type": "string", "description": "the iOS bundle id of iOS app to handle the action code" }, "userIp": { "description": "The IP address of the user.", "type": "string" }, "continueUrl": { "type": "string", "description": "The url to continue to the Gitkit app" }, "requestType": { "description": "The request type.", "type": "string" }, "newEmail": { "type": "string", "description": "The new email if the code is for email change." }, "challenge": { "description": "The recaptcha challenge presented to the user.", "type": "string" }, "idToken": { "description": "The user's Gitkit login token for email change.", "type": "string" }, "kind": { "type": "string", "default": "identitytoolkit#relyingparty", "description": "The fixed string \"identitytoolkit#relyingparty\"." } }, "id": "Relyingparty", "description": "Request of getting a code for user confirmation (reset password, change email etc.)", "type": "object" } }, "version": "v3", "kind": "discovery#restDescription", "documentationLink": "https://developers.google.com/identity-toolkit/v3/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/firebase": { "description": "View and administer all your Firebase data and settings" } } } }, "resources": { "relyingparty": { "methods": { "verifyPhoneNumber": { "id": "identitytoolkit.relyingparty.verifyPhoneNumber", "httpMethod": "POST", "description": "Verifies ownership of a phone number and creates/updates the user account accordingly.", "path": "verifyPhoneNumber", "response": { "$ref": "IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getProjectConfig": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "IdentitytoolkitRelyingpartyGetProjectConfigResponse" }, "path": "getProjectConfig", "id": "identitytoolkit.relyingparty.getProjectConfig", "httpMethod": "GET", "description": "Get project configuration.", "parameters": { "projectNumber": { "location": "query", "description": "GCP project number of the request.", "type": "string" }, "delegatedProjectNumber": { "location": "query", "type": "string", "description": "Delegated GCP project number of the request." } } }, "resetPassword": { "request": { "$ref": "IdentitytoolkitRelyingpartyResetPasswordRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ResetPasswordResponse" }, "path": "resetPassword", "id": "identitytoolkit.relyingparty.resetPassword", "httpMethod": "POST", "description": "Reset password for a user." }, "downloadAccount": { "response": { "$ref": "DownloadAccountResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyDownloadAccountRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "id": "identitytoolkit.relyingparty.downloadAccount", "httpMethod": "POST", "description": "Batch download user accounts.", "path": "downloadAccount" }, "setAccountInfo": { "path": "setAccountInfo", "id": "identitytoolkit.relyingparty.setAccountInfo", "httpMethod": "POST", "description": "Set account info for a user.", "request": { "$ref": "IdentitytoolkitRelyingpartySetAccountInfoRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "SetAccountInfoResponse" } }, "signupNewUser": { "response": { "$ref": "SignupNewUserResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartySignupNewUserRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "identitytoolkit.relyingparty.signupNewUser", "httpMethod": "POST", "description": "Signup new user.", "path": "signupNewUser" }, "uploadAccount": { "request": { "$ref": "IdentitytoolkitRelyingpartyUploadAccountRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "response": { "$ref": "UploadAccountResponse" }, "path": "uploadAccount", "id": "identitytoolkit.relyingparty.uploadAccount", "httpMethod": "POST", "description": "Batch upload existing user accounts." }, "setProjectConfig": { "response": { "$ref": "IdentitytoolkitRelyingpartySetProjectConfigResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartySetProjectConfigRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "identitytoolkit.relyingparty.setProjectConfig", "httpMethod": "POST", "description": "Set project configuration.", "path": "setProjectConfig" }, "getPublicKeys": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "IdentitytoolkitRelyingpartyGetPublicKeysResponse" }, "path": "publicKeys", "id": "identitytoolkit.relyingparty.getPublicKeys", "httpMethod": "GET", "description": "Get token signing public key." }, "verifyAssertion": { "response": { "$ref": "VerifyAssertionResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyVerifyAssertionRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "identitytoolkit.relyingparty.verifyAssertion", "httpMethod": "POST", "description": "Verifies the assertion returned by the IdP.", "path": "verifyAssertion" }, "getOobConfirmationCode": { "path": "getOobConfirmationCode", "id": "identitytoolkit.relyingparty.getOobConfirmationCode", "httpMethod": "POST", "description": "Get a code for user action confirmation.", "request": { "$ref": "Relyingparty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GetOobConfirmationCodeResponse" } }, "emailLinkSignin": { "response": { "$ref": "EmailLinkSigninResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyEmailLinkSigninRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "identitytoolkit.relyingparty.emailLinkSignin", "httpMethod": "POST", "description": "Reset password for a user.", "path": "emailLinkSignin" }, "getAccountInfo": { "request": { "$ref": "IdentitytoolkitRelyingpartyGetAccountInfoRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GetAccountInfoResponse" }, "path": "getAccountInfo", "id": "identitytoolkit.relyingparty.getAccountInfo", "httpMethod": "POST", "description": "Returns the account info." }, "deleteAccount": { "request": { "$ref": "IdentitytoolkitRelyingpartyDeleteAccountRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "DeleteAccountResponse" }, "path": "deleteAccount", "id": "identitytoolkit.relyingparty.deleteAccount", "httpMethod": "POST", "description": "Delete user account." }, "sendVerificationCode": { "path": "sendVerificationCode", "id": "identitytoolkit.relyingparty.sendVerificationCode", "httpMethod": "POST", "description": "Send SMS verification code.", "request": { "$ref": "IdentitytoolkitRelyingpartySendVerificationCodeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "IdentitytoolkitRelyingpartySendVerificationCodeResponse" } }, "createAuthUri": { "path": "createAuthUri", "id": "identitytoolkit.relyingparty.createAuthUri", "httpMethod": "POST", "description": "Creates the URI used by the IdP to authenticate the user.", "request": { "$ref": "IdentitytoolkitRelyingpartyCreateAuthUriRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "CreateAuthUriResponse" } }, "signOutUser": { "id": "identitytoolkit.relyingparty.signOutUser", "httpMethod": "POST", "description": "Sign out user.", "path": "signOutUser", "response": { "$ref": "IdentitytoolkitRelyingpartySignOutUserResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartySignOutUserRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "verifyCustomToken": { "id": "identitytoolkit.relyingparty.verifyCustomToken", "httpMethod": "POST", "description": "Verifies the developer asserted ID token.", "path": "verifyCustomToken", "response": { "$ref": "VerifyCustomTokenResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyVerifyCustomTokenRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getRecaptchaParam": { "path": "getRecaptchaParam", "id": "identitytoolkit.relyingparty.getRecaptchaParam", "httpMethod": "GET", "description": "Get recaptcha secure param.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GetRecaptchaParamResponse" } }, "verifyPassword": { "response": { "$ref": "VerifyPasswordResponse" }, "request": { "$ref": "IdentitytoolkitRelyingpartyVerifyPasswordRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "identitytoolkit.relyingparty.verifyPassword", "httpMethod": "POST", "description": "Verifies the user entered password.", "path": "verifyPassword" } } } }, "canonicalName": "Identity Toolkit", "title": "Google Identity Toolkit API", "baseUrl": "https://www.googleapis.com/identitytoolkit/v3/relyingparty/", "batchPath": "batch/identitytoolkit/v3", "description": "Help the third party sites to implement federated login.", "parameters": { "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "alt": { "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json" ], "enum": [ "json" ], "description": "Data format for the response.", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, "userIp": { "location": "query", "description": "Deprecated. Please use quotaUser instead.", "type": "string" }, "quotaUser": { "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", "type": "string", "location": "query" }, "key": { "location": "query", "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" } } }