googleapis/build/src/apis/identitytoolkit/v3.d.ts

Google APIs Client Library for Node.js

/**
 * Copyright 2015 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
 * Google Identity Toolkit API
 *
 * Help the third party sites to implement federated login.
 *
 * @example
 * const google = require('googleapis');
 * const identitytoolkit = google.identitytoolkit('v3');
 *
 * @namespace identitytoolkit
 * @type {Function}
 * @version v3
 * @variation v3
 * @param {object=} options Options for Identitytoolkit
 */
export declare class Identitytoolkit {
    _options: GlobalOptions;
    google: GoogleApis;
    root: this;
    relyingparty: Resource$Relyingparty;
    constructor(options: GlobalOptions, google: GoogleApis);
    getRoot(): this;
}
/**
 * Response of creating the IDP authentication URL.
 */
export interface Schema$CreateAuthUriResponse {
    /**
     * all providers the user has once used to do federated login
     */
    allProviders: string[];
    /**
     * The URI used by the IDP to authenticate the user.
     */
    authUri: string;
    /**
     * True if captcha is required.
     */
    captchaRequired: boolean;
    /**
     * True if the authUri is for user's existing provider.
     */
    forExistingProvider: boolean;
    /**
     * The fixed string identitytoolkit#CreateAuthUriResponse".
     */
    kind: string;
    /**
     * The provider ID of the auth URI.
     */
    providerId: string;
    /**
     * Whether the user is registered if the identifier is an email.
     */
    registered: boolean;
    /**
     * Session ID which should be passed in the following verifyAssertion request.
     */
    sessionId: string;
    /**
     * All sign-in methods this user has used.
     */
    signinMethods: string[];
}
/**
 * Respone of deleting account.
 */
export interface Schema$DeleteAccountResponse {
    /**
     * The fixed string "identitytoolkit#DeleteAccountResponse".
     */
    kind: string;
}
/**
 * Response of downloading accounts in batch.
 */
export interface Schema$DownloadAccountResponse {
    /**
     * The fixed string "identitytoolkit#DownloadAccountResponse".
     */
    kind: string;
    /**
     * The next page token. To be used in a subsequent request to return the next
     * page of results.
     */
    nextPageToken: string;
    /**
     * The user accounts data.
     */
    users: Schema$UserInfo[];
}
/**
 * Response of email signIn.
 */
export interface Schema$EmailLinkSigninResponse {
    /**
     * The user's email.
     */
    email: string;
    /**
     * Expiration time of STS id token in seconds.
     */
    expiresIn: string;
    /**
     * The STS id token to login the newly signed in user.
     */
    idToken: string;
    /**
     * Whether the user is new.
     */
    isNewUser: boolean;
    /**
     * The fixed string "identitytoolkit#EmailLinkSigninResponse".
     */
    kind: string;
    /**
     * The RP local ID of the user.
     */
    localId: string;
    /**
     * The refresh token for the signed in user.
     */
    refreshToken: string;
}
/**
 * Template for an email template.
 */
export interface Schema$EmailTemplate {
    /**
     * Email body.
     */
    body: string;
    /**
     * Email body format.
     */
    format: string;
    /**
     * From address of the email.
     */
    from: string;
    /**
     * From display name.
     */
    fromDisplayName: string;
    /**
     * Reply-to address.
     */
    replyTo: string;
    /**
     * Subject of the email.
     */
    subject: string;
}
/**
 * Response of getting account information.
 */
export interface Schema$GetAccountInfoResponse {
    /**
     * The fixed string "identitytoolkit#GetAccountInfoResponse".
     */
    kind: string;
    /**
     * The info of the users.
     */
    users: Schema$UserInfo[];
}
/**
 * Response of getting a code for user confirmation (reset password, change
 * email etc.).
 */
export interface Schema$GetOobConfirmationCodeResponse {
    /**
     * The email address that the email is sent to.
     */
    email: string;
    /**
     * The fixed string
     * "identitytoolkit#GetOobConfirmationCodeResponse".
     */
    kind: string;
    /**
     * The code to be send to the user.
     */
    oobCode: string;
}
/**
 * Response of getting recaptcha param.
 */
export interface Schema$GetRecaptchaParamResponse {
    /**
     * The fixed string "identitytoolkit#GetRecaptchaParamResponse".
     */
    kind: string;
    /**
     * Site key registered at recaptcha.
     */
    recaptchaSiteKey: string;
    /**
     * The stoken field for the recaptcha widget, used to request captcha
     * challenge.
     */
    recaptchaStoken: string;
}
/**
 * Request to get the IDP authentication URL.
 */
export interface Schema$IdentitytoolkitRelyingpartyCreateAuthUriRequest {
    /**
     * The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android,
     * BUNDLE_ID for iOS.
     */
    appId: string;
    /**
     * Explicitly specify the auth flow type. Currently only support
     * "CODE_FLOW" type. The field is only used for Google provider.
     */
    authFlowType: string;
    /**
     * The relying party OAuth client ID.
     */
    clientId: string;
    /**
     * The opaque value used by the client to maintain context info between the
     * authentication request and the IDP callback.
     */
    context: string;
    /**
     * The URI to which the IDP redirects the user after the federated login flow.
     */
    continueUri: string;
    /**
     * 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.
     */
    customParameter: any;
    /**
     * The hosted domain to restrict sign-in to accounts at that domain for Google
     * Apps hosted accounts.
     */
    hostedDomain: string;
    /**
     * The email or federated ID of the user.
     */
    identifier: string;
    /**
     * The developer's consumer key for OpenId OAuth Extension
     */
    oauthConsumerKey: string;
    /**
     * Additional oauth scopes, beyond the basid user profile, that the user would
     * be prompted to grant
     */
    oauthScope: string;
    /**
     * Optional realm for OpenID protocol. The sub string
     * "scheme://domain:port" of the param "continueUri" is
     * used if this is not set.
     */
    openidRealm: string;
    /**
     * The native app package for OTA installation.
     */
    otaApp: string;
    /**
     * The IdP ID. For white listed IdPs it's a short domain name e.g.
     * google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's
     * the OP identifier.
     */
    providerId: string;
    /**
     * The session_id passed by client.
     */
    sessionId: string;
}
/**
 * Request to delete account.
 */
export interface Schema$IdentitytoolkitRelyingpartyDeleteAccountRequest {
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The GITKit token or STS id token of the authenticated user.
     */
    idToken: string;
    /**
     * The local ID of the user.
     */
    localId: string;
}
/**
 * Request to download user account in batch.
 */
export interface Schema$IdentitytoolkitRelyingpartyDownloadAccountRequest {
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The max number of results to return in the response.
     */
    maxResults: number;
    /**
     * The token for the next page. This should be taken from the previous
     * response.
     */
    nextPageToken: string;
    /**
     * Specify which project (field value is actually project id) to operate. Only
     * used when provided credential.
     */
    targetProjectId: string;
}
/**
 * Request to sign in with email.
 */
export interface Schema$IdentitytoolkitRelyingpartyEmailLinkSigninRequest {
    /**
     * The email address of the user.
     */
    email: string;
    /**
     * Token for linking flow.
     */
    idToken: string;
    /**
     * The confirmation code.
     */
    oobCode: string;
}
/**
 * Request to get the account information.
 */
export interface Schema$IdentitytoolkitRelyingpartyGetAccountInfoRequest {
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The list of emails of the users to inquiry.
     */
    email: string[];
    /**
     * The GITKit token of the authenticated user.
     */
    idToken: string;
    /**
     * The list of local ID's of the users to inquiry.
     */
    localId: string[];
    /**
     * Privileged caller can query users by specified phone number.
     */
    phoneNumber: string[];
}
/**
 * Response of getting the project configuration.
 */
export interface Schema$IdentitytoolkitRelyingpartyGetProjectConfigResponse {
    /**
     * Whether to allow password user sign in or sign up.
     */
    allowPasswordUser: boolean;
    /**
     * Browser API key, needed when making http request to Apiary.
     */
    apiKey: string;
    /**
     * Authorized domains.
     */
    authorizedDomains: string[];
    /**
     * Change email template.
     */
    changeEmailTemplate: Schema$EmailTemplate;
    dynamicLinksDomain: string;
    /**
     * Whether anonymous user is enabled.
     */
    enableAnonymousUser: boolean;
    /**
     * OAuth2 provider configuration.
     */
    idpConfig: Schema$IdpConfig[];
    /**
     * Legacy reset password email template.
     */
    legacyResetPasswordTemplate: Schema$EmailTemplate;
    /**
     * Project ID of the relying party.
     */
    projectId: string;
    /**
     * Reset password email template.
     */
    resetPasswordTemplate: Schema$EmailTemplate;
    /**
     * Whether to use email sending provided by Firebear.
     */
    useEmailSending: boolean;
    /**
     * Verify email template.
     */
    verifyEmailTemplate: Schema$EmailTemplate;
}
/**
 * Respone of getting public keys.
 */
export interface Schema$IdentitytoolkitRelyingpartyGetPublicKeysResponse {
}
/**
 * Request to reset the password.
 */
export interface Schema$IdentitytoolkitRelyingpartyResetPasswordRequest {
    /**
     * The email address of the user.
     */
    email: string;
    /**
     * The new password inputted by the user.
     */
    newPassword: string;
    /**
     * The old password inputted by the user.
     */
    oldPassword: string;
    /**
     * The confirmation code.
     */
    oobCode: string;
}
/**
 * Request for Identitytoolkit-SendVerificationCode
 */
export interface Schema$IdentitytoolkitRelyingpartySendVerificationCodeRequest {
    /**
     * Receipt of successful app token validation with APNS.
     */
    iosReceipt: string;
    /**
     * Secret delivered to iOS app via APNS.
     */
    iosSecret: string;
    /**
     * The phone number to send the verification code to in E.164 format.
     */
    phoneNumber: string;
    /**
     * Recaptcha solution.
     */
    recaptchaToken: string;
}
/**
 * Response for Identitytoolkit-SendVerificationCode
 */
export interface Schema$IdentitytoolkitRelyingpartySendVerificationCodeResponse {
    /**
     * Encrypted session information
     */
    sessionInfo: string;
}
/**
 * Request to set the account information.
 */
export interface Schema$IdentitytoolkitRelyingpartySetAccountInfoRequest {
    /**
     * The captcha challenge.
     */
    captchaChallenge: string;
    /**
     * Response to the captcha.
     */
    captchaResponse: string;
    /**
     * The timestamp when the account is created.
     */
    createdAt: string;
    /**
     * The custom attributes to be set in the user's id token.
     */
    customAttributes: string;
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The attributes users request to delete.
     */
    deleteAttribute: string[];
    /**
     * The IDPs the user request to delete.
     */
    deleteProvider: string[];
    /**
     * Whether to disable the user.
     */
    disableUser: boolean;
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * Mark the email as verified or not.
     */
    emailVerified: boolean;
    /**
     * The GITKit token of the authenticated user.
     */
    idToken: string;
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * Last login timestamp.
     */
    lastLoginAt: string;
    /**
     * The local ID of the user.
     */
    localId: string;
    /**
     * The out-of-band code of the change email request.
     */
    oobCode: string;
    /**
     * The new password of the user.
     */
    password: string;
    /**
     * Privileged caller can update user with specified phone number.
     */
    phoneNumber: string;
    /**
     * The photo url of the user.
     */
    photoUrl: string;
    /**
     * The associated IDPs of the user.
     */
    provider: string[];
    /**
     * Whether return sts id token and refresh token instead of gitkit token.
     */
    returnSecureToken: boolean;
    /**
     * Mark the user to upgrade to federated login.
     */
    upgradeToFederatedLogin: boolean;
    /**
     * Timestamp in seconds for valid login token.
     */
    validSince: string;
}
/**
 * Request to set the project configuration.
 */
export interface Schema$IdentitytoolkitRelyingpartySetProjectConfigRequest {
    /**
     * Whether to allow password user sign in or sign up.
     */
    allowPasswordUser: boolean;
    /**
     * Browser API key, needed when making http request to Apiary.
     */
    apiKey: string;
    /**
     * Authorized domains for widget redirect.
     */
    authorizedDomains: string[];
    /**
     * Change email template.
     */
    changeEmailTemplate: Schema$EmailTemplate;
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * Whether to enable anonymous user.
     */
    enableAnonymousUser: boolean;
    /**
     * Oauth2 provider configuration.
     */
    idpConfig: Schema$IdpConfig[];
    /**
     * Legacy reset password email template.
     */
    legacyResetPasswordTemplate: Schema$EmailTemplate;
    /**
     * Reset password email template.
     */
    resetPasswordTemplate: Schema$EmailTemplate;
    /**
     * Whether to use email sending provided by Firebear.
     */
    useEmailSending: boolean;
    /**
     * Verify email template.
     */
    verifyEmailTemplate: Schema$EmailTemplate;
}
/**
 * Response of setting the project configuration.
 */
export interface Schema$IdentitytoolkitRelyingpartySetProjectConfigResponse {
    /**
     * Project ID of the relying party.
     */
    projectId: string;
}
/**
 * Request to sign out user.
 */
export interface Schema$IdentitytoolkitRelyingpartySignOutUserRequest {
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * The local ID of the user.
     */
    localId: string;
}
/**
 * Response of signing out user.
 */
export interface Schema$IdentitytoolkitRelyingpartySignOutUserResponse {
    /**
     * The local ID of the user.
     */
    localId: string;
}
/**
 * Request to signup new user, create anonymous user or anonymous user reauth.
 */
export interface Schema$IdentitytoolkitRelyingpartySignupNewUserRequest {
    /**
     * The captcha challenge.
     */
    captchaChallenge: string;
    /**
     * Response to the captcha.
     */
    captchaResponse: string;
    /**
     * Whether to disable the user. Only can be used by service account.
     */
    disabled: boolean;
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * Mark the email as verified or not. Only can be used by service account.
     */
    emailVerified: boolean;
    /**
     * The GITKit token of the authenticated user.
     */
    idToken: string;
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * Privileged caller can create user with specified user id.
     */
    localId: string;
    /**
     * The new password of the user.
     */
    password: string;
    /**
     * Privileged caller can create user with specified phone number.
     */
    phoneNumber: string;
    /**
     * The photo url of the user.
     */
    photoUrl: string;
}
/**
 * Request to upload user account in batch.
 */
export interface Schema$IdentitytoolkitRelyingpartyUploadAccountRequest {
    /**
     * Whether allow overwrite existing account when user local_id exists.
     */
    allowOverwrite: boolean;
    blockSize: number;
    /**
     * The following 4 fields are for standard scrypt algorithm.
     */
    cpuMemCost: number;
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    dkLen: number;
    /**
     * The password hash algorithm.
     */
    hashAlgorithm: string;
    /**
     * Memory cost for hash calculation. Used by scrypt similar algorithms.
     */
    memoryCost: number;
    parallelization: number;
    /**
     * Rounds for hash calculation. Used by scrypt and similar algorithms.
     */
    rounds: number;
    /**
     * The salt separator.
     */
    saltSeparator: string;
    /**
     * If true, backend will do sanity check(including duplicate email and
     * federated id) when uploading account.
     */
    sanityCheck: boolean;
    /**
     * The key for to hash the password.
     */
    signerKey: string;
    /**
     * Specify which project (field value is actually project id) to operate. Only
     * used when provided credential.
     */
    targetProjectId: string;
    /**
     * The account info to be stored.
     */
    users: Schema$UserInfo[];
}
/**
 * Request to verify the IDP assertion.
 */
export interface Schema$IdentitytoolkitRelyingpartyVerifyAssertionRequest {
    /**
     * 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.
     */
    autoCreate: boolean;
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The GITKit token of the authenticated user.
     */
    idToken: string;
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * The GITKit token for the non-trusted IDP pending to be confirmed by the
     * user.
     */
    pendingIdToken: string;
    /**
     * The post body if the request is a HTTP POST.
     */
    postBody: string;
    /**
     * The URI to which the IDP redirects the user back. It may contain federated
     * login result params added by the IDP.
     */
    requestUri: string;
    /**
     * Whether return 200 and IDP credential rather than throw exception when
     * federated id is already linked.
     */
    returnIdpCredential: boolean;
    /**
     * Whether to return refresh tokens.
     */
    returnRefreshToken: boolean;
    /**
     * Whether return sts id token and refresh token instead of gitkit token.
     */
    returnSecureToken: boolean;
    /**
     * Session ID, which should match the one in previous createAuthUri request.
     */
    sessionId: string;
}
/**
 * Request to verify a custom token
 */
export interface Schema$IdentitytoolkitRelyingpartyVerifyCustomTokenRequest {
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * Whether return sts id token and refresh token instead of gitkit token.
     */
    returnSecureToken: boolean;
    /**
     * The custom token to verify
     */
    token: string;
}
/**
 * Request to verify the password.
 */
export interface Schema$IdentitytoolkitRelyingpartyVerifyPasswordRequest {
    /**
     * The captcha challenge.
     */
    captchaChallenge: string;
    /**
     * Response to the captcha.
     */
    captchaResponse: string;
    /**
     * GCP project number of the requesting delegated app. Currently only intended
     * for Firebase V1 migration.
     */
    delegatedProjectNumber: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * The GITKit token of the authenticated user.
     */
    idToken: string;
    /**
     * Instance id token of the app.
     */
    instanceId: string;
    /**
     * The password inputed by the user.
     */
    password: string;
    /**
     * The GITKit token for the non-trusted IDP, which is to be confirmed by the
     * user.
     */
    pendingIdToken: string;
    /**
     * Whether return sts id token and refresh token instead of gitkit token.
     */
    returnSecureToken: boolean;
}
/**
 * Request for Identitytoolkit-VerifyPhoneNumber
 */
export interface Schema$IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest {
    code: string;
    idToken: string;
    operation: string;
    phoneNumber: string;
    /**
     * The session info previously returned by
     * IdentityToolkit-SendVerificationCode.
     */
    sessionInfo: string;
    temporaryProof: string;
    verificationProof: string;
}
/**
 * Response for Identitytoolkit-VerifyPhoneNumber
 */
export interface Schema$IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse {
    expiresIn: string;
    idToken: string;
    isNewUser: boolean;
    localId: string;
    phoneNumber: string;
    refreshToken: string;
    temporaryProof: string;
    temporaryProofExpiresIn: string;
    verificationProof: string;
    verificationProofExpiresIn: string;
}
/**
 * Template for a single idp configuration.
 */
export interface Schema$IdpConfig {
    /**
     * OAuth2 client ID.
     */
    clientId: string;
    /**
     * Whether this IDP is enabled.
     */
    enabled: boolean;
    /**
     * Percent of users who will be prompted/redirected federated login for this
     * IDP.
     */
    experimentPercent: number;
    /**
     * OAuth2 provider.
     */
    provider: string;
    /**
     * OAuth2 client secret.
     */
    secret: string;
    /**
     * Whitelisted client IDs for audience check.
     */
    whitelistedAudiences: string[];
}
/**
 * Request of getting a code for user confirmation (reset password, change email
 * etc.)
 */
export interface Schema$Relyingparty {
    /**
     * whether or not to install the android app on the device where the link is
     * opened
     */
    androidInstallApp: boolean;
    /**
     * 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
     */
    androidMinimumVersion: string;
    /**
     * android package name of the android app to handle the action code
     */
    androidPackageName: string;
    /**
     * whether or not the app can handle the oob code without first going to web
     */
    canHandleCodeInApp: boolean;
    /**
     * The recaptcha response from the user.
     */
    captchaResp: string;
    /**
     * The recaptcha challenge presented to the user.
     */
    challenge: string;
    /**
     * The url to continue to the Gitkit app
     */
    continueUrl: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * The user's Gitkit login token for email change.
     */
    idToken: string;
    /**
     * iOS app store id to download the app if it's not already installed
     */
    iOSAppStoreId: string;
    /**
     * the iOS bundle id of iOS app to handle the action code
     */
    iOSBundleId: string;
    /**
     * The fixed string "identitytoolkit#relyingparty".
     */
    kind: string;
    /**
     * The new email if the code is for email change.
     */
    newEmail: string;
    /**
     * The request type.
     */
    requestType: string;
    /**
     * The IP address of the user.
     */
    userIp: string;
}
/**
 * Response of resetting the password.
 */
export interface Schema$ResetPasswordResponse {
    /**
     * The user's email. If the out-of-band code is for email recovery, the
     * user's original email.
     */
    email: string;
    /**
     * The fixed string "identitytoolkit#ResetPasswordResponse".
     */
    kind: string;
    /**
     * If the out-of-band code is for email recovery, the user's new email.
     */
    newEmail: string;
    /**
     * The request type.
     */
    requestType: string;
}
/**
 * Respone of setting the account information.
 */
export interface Schema$SetAccountInfoResponse {
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * If email has been verified.
     */
    emailVerified: boolean;
    /**
     * If idToken is STS id token, then this field will be expiration time of STS
     * id token in seconds.
     */
    expiresIn: string;
    /**
     * The Gitkit id token to login the newly sign up user.
     */
    idToken: string;
    /**
     * The fixed string "identitytoolkit#SetAccountInfoResponse".
     */
    kind: string;
    /**
     * The local ID of the user.
     */
    localId: string;
    /**
     * The new email the user attempts to change to.
     */
    newEmail: string;
    /**
     * The user's hashed password.
     */
    passwordHash: string;
    /**
     * The photo url of the user.
     */
    photoUrl: string;
    /**
     * The user's profiles at the associated IdPs.
     */
    providerUserInfo: any[];
    /**
     * If idToken is STS id token, then this field will be refresh token.
     */
    refreshToken: string;
}
/**
 * Response of signing up new user, creating anonymous user or anonymous user
 * reauth.
 */
export interface Schema$SignupNewUserResponse {
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * If idToken is STS id token, then this field will be expiration time of STS
     * id token in seconds.
     */
    expiresIn: string;
    /**
     * The Gitkit id token to login the newly sign up user.
     */
    idToken: string;
    /**
     * The fixed string "identitytoolkit#SignupNewUserResponse".
     */
    kind: string;
    /**
     * The RP local ID of the user.
     */
    localId: string;
    /**
     * If idToken is STS id token, then this field will be refresh token.
     */
    refreshToken: string;
}
/**
 * Respone of uploading accounts in batch.
 */
export interface Schema$UploadAccountResponse {
    /**
     * The error encountered while processing the account info.
     */
    error: any[];
    /**
     * The fixed string "identitytoolkit#UploadAccountResponse".
     */
    kind: string;
}
/**
 * Template for an individual account info.
 */
export interface Schema$UserInfo {
    /**
     * User creation timestamp.
     */
    createdAt: string;
    /**
     * The custom attributes to be set in the user's id token.
     */
    customAttributes: string;
    /**
     * Whether the user is authenticated by the developer.
     */
    customAuth: boolean;
    /**
     * Whether the user is disabled.
     */
    disabled: boolean;
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email of the user.
     */
    email: string;
    /**
     * Whether the email has been verified.
     */
    emailVerified: boolean;
    /**
     * last login timestamp.
     */
    lastLoginAt: string;
    /**
     * The local ID of the user.
     */
    localId: string;
    /**
     * The user's hashed password.
     */
    passwordHash: string;
    /**
     * The timestamp when the password was last updated.
     */
    passwordUpdatedAt: number;
    /**
     * User's phone number.
     */
    phoneNumber: string;
    /**
     * The URL of the user profile photo.
     */
    photoUrl: string;
    /**
     * The IDP of the user.
     */
    providerUserInfo: any[];
    /**
     * The user's plain text password.
     */
    rawPassword: string;
    /**
     * The user's password salt.
     */
    salt: string;
    /**
     * User's screen name at Twitter or login name at Github.
     */
    screenName: string;
    /**
     * Timestamp in seconds for valid login token.
     */
    validSince: string;
    /**
     * Version of the user's password.
     */
    version: number;
}
/**
 * Response of verifying the IDP assertion.
 */
export interface Schema$VerifyAssertionResponse {
    /**
     * The action code.
     */
    action: string;
    /**
     * URL for OTA app installation.
     */
    appInstallationUrl: string;
    /**
     * The custom scheme used by mobile app.
     */
    appScheme: string;
    /**
     * The opaque value used by the client to maintain context info between the
     * authentication request and the IDP callback.
     */
    context: string;
    /**
     * The birth date of the IdP account.
     */
    dateOfBirth: string;
    /**
     * The display name of the user.
     */
    displayName: string;
    /**
     * The email returned by the IdP. NOTE: The federated login user may not own
     * the email.
     */
    email: string;
    /**
     * It's true if the email is recycled.
     */
    emailRecycled: boolean;
    /**
     * The value is true if the IDP is also the email provider. It means the user
     * owns the email.
     */
    emailVerified: boolean;
    /**
     * Client error code.
     */
    errorMessage: string;
    /**
     * If idToken is STS id token, then this field will be expiration time of STS
     * id token in seconds.
     */
    expiresIn: string;
    /**
     * The unique ID identifies the IdP account.
     */
    federatedId: string;
    /**
     * The first name of the user.
     */
    firstName: string;
    /**
     * The full name of the user.
     */
    fullName: string;
    /**
     * The ID token.
     */
    idToken: string;
    /**
     * It's the identifier param in the createAuthUri request if the
     * identifier is an email. It can be used to check whether the user input
     * email is different from the asserted email.
     */
    inputEmail: string;
    /**
     * True if it's a new user sign-in, false if it's a returning user.
     */
    isNewUser: boolean;
    /**
     * The fixed string "identitytoolkit#VerifyAssertionResponse".
     */
    kind: string;
    /**
     * The language preference of the user.
     */
    language: string;
    /**
     * The last name of the user.
     */
    lastName: string;
    /**
     * The RP local ID if it's already been mapped to the IdP account
     * identified by the federated ID.
     */
    localId: string;
    /**
     * Whether the assertion is from a non-trusted IDP and need account linking
     * confirmation.
     */
    needConfirmation: boolean;
    /**
     * Whether need client to supply email to complete the federated login flow.
     */
    needEmail: boolean;
    /**
     * The nick name of the user.
     */
    nickName: string;
    /**
     * The OAuth2 access token.
     */
    oauthAccessToken: string;
    /**
     * The OAuth2 authorization code.
     */
    oauthAuthorizationCode: string;
    /**
     * The lifetime in seconds of the OAuth2 access token.
     */
    oauthExpireIn: number;
    /**
     * The OIDC id token.
     */
    oauthIdToken: string;
    /**
     * The user approved request token for the OpenID OAuth extension.
     */
    oauthRequestToken: string;
    /**
     * The scope for the OpenID OAuth extension.
     */
    oauthScope: string;
    /**
     * The OAuth1 access token secret.
     */
    oauthTokenSecret: string;
    /**
     * The original email stored in the mapping storage. It's returned when
     * the federated ID is associated to a different email.
     */
    originalEmail: string;
    /**
     * The URI of the public accessible profiel picture.
     */
    photoUrl: string;
    /**
     * The IdP ID. For white listed IdPs it's a short domain name e.g.
     * google.com, aol.com, live.net and yahoo.com. If the "providerId"
     * param is set to OpenID OP identifer other than the whilte listed IdPs the
     * OP identifier is returned. If the "identifier" param is federated
     * ID in the createAuthUri request. The domain part of the federated ID is
     * returned.
     */
    providerId: string;
    /**
     * Raw IDP-returned user info.
     */
    rawUserInfo: string;
    /**
     * If idToken is STS id token, then this field will be refresh token.
     */
    refreshToken: string;
    /**
     * The screen_name of a Twitter user or the login name at Github.
     */
    screenName: string;
    /**
     * The timezone of the user.
     */
    timeZone: string;
    /**
     * When action is 'map', contains the idps which can be used for
     * confirmation.
     */
    verifiedProvider: string[];
}
/**
 * Response from verifying a custom token
 */
export interface Schema$VerifyCustomTokenResponse {
    /**
     * If idToken is STS id token, then this field will be expiration time of STS
     * id token in seconds.
     */
    expiresIn: string;
    /**
     * The GITKit token for authenticated user.
     */
    idToken: string;
    /**
     * True if it's a new user sign-in, false if it's a returning user.
     */
    isNewUser: boolean;
    /**
     * The fixed string "identitytoolkit#VerifyCustomTokenResponse".
     */
    kind: string;
    /**
     * If idToken is STS id token, then this field will be refresh token.
     */
    refreshToken: string;
}
/**
 * Request of verifying the password.
 */
export interface Schema$VerifyPasswordResponse {
    /**
     * The name of the user.
     */
    displayName: string;
    /**
     * The email returned by the IdP. NOTE: The federated login user may not own
     * the email.
     */
    email: string;
    /**
     * If idToken is STS id token, then this field will be expiration time of STS
     * id token in seconds.
     */
    expiresIn: string;
    /**
     * The GITKit token for authenticated user.
     */
    idToken: string;
    /**
     * The fixed string "identitytoolkit#VerifyPasswordResponse".
     */
    kind: string;
    /**
     * The RP local ID if it's already been mapped to the IdP account
     * identified by the federated ID.
     */
    localId: string;
    /**
     * The OAuth2 access token.
     */
    oauthAccessToken: string;
    /**
     * The OAuth2 authorization code.
     */
    oauthAuthorizationCode: string;
    /**
     * The lifetime in seconds of the OAuth2 access token.
     */
    oauthExpireIn: number;
    /**
     * The URI of the user's photo at IdP
     */
    photoUrl: string;
    /**
     * If idToken is STS id token, then this field will be refresh token.
     */
    refreshToken: string;
    /**
     * Whether the email is registered.
     */
    registered: boolean;
}
export declare class Resource$Relyingparty {
    root: Identitytoolkit;
    constructor(root: Identitytoolkit);
    getRoot(): Identitytoolkit;
    /**
     * identitytoolkit.relyingparty.createAuthUri
     * @desc Creates the URI used by the IdP to authenticate the user.
     * @alias identitytoolkit.relyingparty.createAuthUri
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyCreateAuthUriRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    createAuthUri(params?: any, options?: MethodOptions): AxiosPromise<Schema$CreateAuthUriResponse>;
    createAuthUri(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$CreateAuthUriResponse>, callback?: BodyResponseCallback<Schema$CreateAuthUriResponse>): void;
    /**
     * identitytoolkit.relyingparty.deleteAccount
     * @desc Delete user account.
     * @alias identitytoolkit.relyingparty.deleteAccount
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyDeleteAccountRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    deleteAccount(params?: any, options?: MethodOptions): AxiosPromise<Schema$DeleteAccountResponse>;
    deleteAccount(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$DeleteAccountResponse>, callback?: BodyResponseCallback<Schema$DeleteAccountResponse>): void;
    /**
     * identitytoolkit.relyingparty.downloadAccount
     * @desc Batch download user accounts.
     * @alias identitytoolkit.relyingparty.downloadAccount
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyDownloadAccountRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    downloadAccount(params?: any, options?: MethodOptions): AxiosPromise<Schema$DownloadAccountResponse>;
    downloadAccount(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$DownloadAccountResponse>, callback?: BodyResponseCallback<Schema$DownloadAccountResponse>): void;
    /**
     * identitytoolkit.relyingparty.emailLinkSignin
     * @desc Reset password for a user.
     * @alias identitytoolkit.relyingparty.emailLinkSignin
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyEmailLinkSigninRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    emailLinkSignin(params?: any, options?: MethodOptions): AxiosPromise<Schema$EmailLinkSigninResponse>;
    emailLinkSignin(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$EmailLinkSigninResponse>, callback?: BodyResponseCallback<Schema$EmailLinkSigninResponse>): void;
    /**
     * identitytoolkit.relyingparty.getAccountInfo
     * @desc Returns the account info.
     * @alias identitytoolkit.relyingparty.getAccountInfo
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyGetAccountInfoRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    getAccountInfo(params?: any, options?: MethodOptions): AxiosPromise<Schema$GetAccountInfoResponse>;
    getAccountInfo(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$GetAccountInfoResponse>, callback?: BodyResponseCallback<Schema$GetAccountInfoResponse>): void;
    /**
     * identitytoolkit.relyingparty.getOobConfirmationCode
     * @desc Get a code for user action confirmation.
     * @alias identitytoolkit.relyingparty.getOobConfirmationCode
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().Relyingparty} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    getOobConfirmationCode(params?: any, options?: MethodOptions): AxiosPromise<Schema$GetOobConfirmationCodeResponse>;
    getOobConfirmationCode(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$GetOobConfirmationCodeResponse>, callback?: BodyResponseCallback<Schema$GetOobConfirmationCodeResponse>): void;
    /**
     * identitytoolkit.relyingparty.getProjectConfig
     * @desc Get project configuration.
     * @alias identitytoolkit.relyingparty.getProjectConfig
     * @memberOf! ()
     *
     * @param {object=} params Parameters for request
     * @param {string=} params.delegatedProjectNumber Delegated GCP project number of the request.
     * @param {string=} params.projectNumber GCP project number of the request.
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    getProjectConfig(params?: any, options?: MethodOptions): AxiosPromise<Schema$IdentitytoolkitRelyingpartyGetProjectConfigResponse>;
    getProjectConfig(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$IdentitytoolkitRelyingpartyGetProjectConfigResponse>, callback?: BodyResponseCallback<Schema$IdentitytoolkitRelyingpartyGetProjectConfigResponse>): void;
    /**
     * identitytoolkit.relyingparty.getPublicKeys
     * @desc Get token signing public key.
     * @alias identitytoolkit.relyingparty.getPublicKeys
     * @memberOf! ()
     *
     * @param {object=} params Parameters for request
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    getPublicKeys(params?: any, options?: MethodOptions): AxiosPromise<Schema$IdentitytoolkitRelyingpartyGetPublicKeysResponse>;
    getPublicKeys(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$IdentitytoolkitRelyingpartyGetPublicKeysResponse>, callback?: BodyResponseCallback<Schema$IdentitytoolkitRelyingpartyGetPublicKeysResponse>): void;
    /**
     * identitytoolkit.relyingparty.getRecaptchaParam
     * @desc Get recaptcha secure param.
     * @alias identitytoolkit.relyingparty.getRecaptchaParam
     * @memberOf! ()
     *
     * @param {object=} params Parameters for request
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    getRecaptchaParam(params?: any, options?: MethodOptions): AxiosPromise<Schema$GetRecaptchaParamResponse>;
    getRecaptchaParam(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$GetRecaptchaParamResponse>, callback?: BodyResponseCallback<Schema$GetRecaptchaParamResponse>): void;
    /**
     * identitytoolkit.relyingparty.resetPassword
     * @desc Reset password for a user.
     * @alias identitytoolkit.relyingparty.resetPassword
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartyResetPasswordRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    resetPassword(params?: any, options?: MethodOptions): AxiosPromise<Schema$ResetPasswordResponse>;
    resetPassword(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$ResetPasswordResponse>, callback?: BodyResponseCallback<Schema$ResetPasswordResponse>): void;
    /**
     * identitytoolkit.relyingparty.sendVerificationCode
     * @desc Send SMS verification code.
     * @alias identitytoolkit.relyingparty.sendVerificationCode
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartySendVerificationCodeRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    sendVerificationCode(params?: any, options?: MethodOptions): AxiosPromise<Schema$IdentitytoolkitRelyingpartySendVerificationCodeResponse>;
    sendVerificationCode(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySendVerificationCodeResponse>, callback?: BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySendVerificationCodeResponse>): void;
    /**
     * identitytoolkit.relyingparty.setAccountInfo
     * @desc Set account info for a user.
     * @alias identitytoolkit.relyingparty.setAccountInfo
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartySetAccountInfoRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    setAccountInfo(params?: any, options?: MethodOptions): AxiosPromise<Schema$SetAccountInfoResponse>;
    setAccountInfo(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$SetAccountInfoResponse>, callback?: BodyResponseCallback<Schema$SetAccountInfoResponse>): void;
    /**
     * identitytoolkit.relyingparty.setProjectConfig
     * @desc Set project configuration.
     * @alias identitytoolkit.relyingparty.setProjectConfig
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartySetProjectConfigRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    setProjectConfig(params?: any, options?: MethodOptions): AxiosPromise<Schema$IdentitytoolkitRelyingpartySetProjectConfigResponse>;
    setProjectConfig(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySetProjectConfigResponse>, callback?: BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySetProjectConfigResponse>): void;
    /**
     * identitytoolkit.relyingparty.signOutUser
     * @desc Sign out user.
     * @alias identitytoolkit.relyingparty.signOutUser
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartySignOutUserRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    signOutUser(params?: any, options?: MethodOptions): AxiosPromise<Schema$IdentitytoolkitRelyingpartySignOutUserResponse>;
    signOutUser(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySignOutUserResponse>, callback?: BodyResponseCallback<Schema$IdentitytoolkitRelyingpartySignOutUserResponse>): void;
    /**
     * identitytoolkit.relyingparty.signupNewUser
     * @desc Signup new user.
     * @alias identitytoolkit.relyingparty.signupNewUser
     * @memberOf! ()
     *
     * @param {object} params Parameters for request
     * @param {().IdentitytoolkitRelyingpartySignupNewUserRequest} params.resource Request body data
     * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
     * @param {callback} callback The callback that handles the response.
     * @return {object} Request object
     */
    signupNewUser(params?: any, options?: MethodOptions): AxiosPromise<Schema$SignupNewUserResponse>;
    signupNewUser(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$SignupNewUserResponse>, callback?: BodyResponseCallback<Schema$SignupNewUserResponse>): void;
    /**
     * identityt