UNPKG

1.44 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC
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 */
17import { Auth, UserCredential } from '../../model/public_types';
18/**
19 * Asynchronously signs in using a custom token.
20 *
21 * @remarks
22 * Custom tokens are used to integrate Firebase Auth with existing auth systems, and must
23 * be generated by an auth backend using the
24 * {@link https://firebase.google.com/docs/reference/admin/node/admin.auth.Auth#createcustomtoken | createCustomToken}
25 * method in the {@link https://firebase.google.com/docs/auth/admin | Admin SDK} .
26 *
27 * Fails with an error if the token is invalid, expired, or not accepted by the Firebase Auth service.
28 *
29 * @param auth - The {@link Auth} instance.
30 * @param customToken - The custom token to sign in with.
31 *
32 * @public
33 */
34export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;