index.d.ts 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. /**
  18. * Firebase Authentication.
  19. *
  20. * @packageDocumentation
  21. */
  22. import { App } from '../app/index';
  23. import { Auth } from './auth';
  24. /**
  25. * Gets the {@link Auth} service for the default app or a
  26. * given app.
  27. *
  28. * `getAuth()` can be called with no arguments to access the default app's
  29. * {@link Auth} service or as `getAuth(app)` to access the
  30. * {@link Auth} service associated with a specific app.
  31. *
  32. * @example
  33. * ```javascript
  34. * // Get the Auth service for the default app
  35. * const defaultAuth = getAuth();
  36. * ```
  37. *
  38. * @example
  39. * ```javascript
  40. * // Get the Auth service for a given app
  41. * const otherAuth = getAuth(otherApp);
  42. * ```
  43. *
  44. */
  45. export declare function getAuth(app?: App): Auth;
  46. export { ActionCodeSettings } from './action-code-settings-builder';
  47. export { Auth, } from './auth';
  48. export { AllowByDefault, AllowByDefaultWrap, AllowlistOnly, AllowlistOnlyWrap, AuthFactorType, AuthProviderConfig, AuthProviderConfigFilter, BaseAuthProviderConfig, BaseCreateMultiFactorInfoRequest, BaseUpdateMultiFactorInfoRequest, CreateMultiFactorInfoRequest, CreatePhoneMultiFactorInfoRequest, CreateRequest, EmailSignInProviderConfig, ListProviderConfigResults, MultiFactorConfig, MultiFactorConfigState, MultiFactorCreateSettings, MultiFactorUpdateSettings, MultiFactorProviderConfig, OAuthResponseType, OIDCAuthProviderConfig, OIDCUpdateAuthProviderRequest, RecaptchaAction, RecaptchaConfig, RecaptchaKey, RecaptchaKeyClientType, RecaptchaManagedRule, RecaptchaProviderEnforcementState, SAMLAuthProviderConfig, SAMLUpdateAuthProviderRequest, SmsRegionConfig, UserProvider, UpdateAuthProviderRequest, UpdateMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, UpdateRequest, TotpMultiFactorProviderConfig, PasswordPolicyConfig, PasswordPolicyEnforcementState, CustomStrengthOptionsConfig, EmailPrivacyConfig, } from './auth-config';
  49. export { BaseAuth, DeleteUsersResult, GetUsersResult, ListUsersResult, SessionCookieOptions, } from './base-auth';
  50. export { EmailIdentifier, PhoneIdentifier, ProviderIdentifier, UidIdentifier, UserIdentifier, } from './identifier';
  51. export { CreateTenantRequest, Tenant, UpdateTenantRequest, } from './tenant';
  52. export { ListTenantsResult, TenantAwareAuth, TenantManager, } from './tenant-manager';
  53. export { UpdateProjectConfigRequest, ProjectConfig, } from './project-config';
  54. export { ProjectConfigManager, } from './project-config-manager';
  55. export { DecodedIdToken, DecodedAuthBlockingToken } from './token-verifier';
  56. export { HashAlgorithmType, UserImportOptions, UserImportRecord, UserImportResult, UserMetadataRequest, UserProviderRequest, } from './user-import-builder';
  57. export { MultiFactorInfo, MultiFactorSettings, PhoneMultiFactorInfo, UserInfo, UserMetadata, UserRecord, } from './user-record';
  58. export { FirebaseAuthError, AuthClientErrorCode, } from '../utils/error';