UNPKG

2.83 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
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 */
22import { App } from '../app/index';
23import { 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 */
45export declare function getAuth(app?: App): Auth;
46export { ActionCodeSettings } from './action-code-settings-builder';
47export { Auth, } from './auth';
48export { AuthFactorType, AuthProviderConfig, AuthProviderConfigFilter, BaseAuthProviderConfig, BaseCreateMultiFactorInfoRequest, BaseUpdateMultiFactorInfoRequest, CreateMultiFactorInfoRequest, CreatePhoneMultiFactorInfoRequest, CreateRequest, EmailSignInProviderConfig, ListProviderConfigResults, MultiFactorConfig, MultiFactorConfigState, MultiFactorCreateSettings, MultiFactorUpdateSettings, OAuthResponseType, OIDCAuthProviderConfig, OIDCUpdateAuthProviderRequest, SAMLAuthProviderConfig, SAMLUpdateAuthProviderRequest, UserProvider, UpdateAuthProviderRequest, UpdateMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, UpdateRequest, } from './auth-config';
49export { BaseAuth, DeleteUsersResult, GetUsersResult, ListUsersResult, SessionCookieOptions, } from './base-auth';
50export { EmailIdentifier, PhoneIdentifier, ProviderIdentifier, UidIdentifier, UserIdentifier, } from './identifier';
51export { CreateTenantRequest, Tenant, UpdateTenantRequest, } from './tenant';
52export { ListTenantsResult, TenantAwareAuth, TenantManager, } from './tenant-manager';
53export { DecodedIdToken } from './token-verifier';
54export { HashAlgorithmType, UserImportOptions, UserImportRecord, UserImportResult, UserMetadataRequest, UserProviderRequest, } from './user-import-builder';
55export { MultiFactorInfo, MultiFactorSettings, PhoneMultiFactorInfo, UserInfo, UserMetadata, UserRecord, } from './user-record';