auth package

Firebase 인증

함수

함수 설명
function(앱, ...)
getAuth(app) 제공된 FirebaseApp과 연결된 Auth 인스턴스를 반환합니다. 인스턴스가 없으면 플랫폼별 기본 종속 항목이 있는 Auth 인스턴스를 초기화합니다.
initializeAuth(app, deps) 종속 항목을 세밀하게 제어하여 Auth 인스턴스를 초기화합니다.
함수(스토리지, ...)
getReactNativePersistence(storage) react-native 또는 @react-native-community/async-storage에서 가져온 AsyncStorage를 래핑하는 지속성 객체를 반환하며 initializeAuth()의 지속성 종속 항목 필드에서 사용할 수 있습니다.
함수(인증, ...)
applyActionCode(auth, oobCode) 이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 인증 코드를 적용합니다.
beforeAuthStateChanged(auth, callback, onAbort) 인증 상태 변경으로 신규 사용자를 설정하기 전에 실행되는 차단 콜백을 추가합니다.
checkActionCode(auth, oobCode) 이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 인증 코드를 확인합니다.
confirmPasswordReset(auth, oobCode, newPassword) 확인 코드와 새 비밀번호를 입력하여 비밀번호 재설정 프로세스를 완료합니다.
connectAuthEmulator(auth, url, options) 프로덕션 Firebase 인증 서비스가 아닌 Firebase 인증 에뮬레이터와 통신하도록 Auth 인스턴스를 변경합니다.
createUserWithEmailAndPassword(auth, email, password) 지정된 이메일 주소 및 비밀번호와 연결된 새 사용자 계정을 만듭니다.
fetchSignInMethodsForEmail(auth, email) 지정된 이메일 주소에 사용할 수 있는 로그인 방법의 목록을 가져옵니다. 이 메서드는 지정된 이메일에 사용할 수 있는 인증 방법의 수에 관계없이 [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)가 사용 설정된 경우 빈 목록을 반환합니다.
getMultiFactorResolver(auth, error) 다단계 흐름을 완료하는 데 적합한 MultiFactorResolver를 제공합니다.
getRedirectResult(auth, resolver) 리디렉션 기반 로그인 흐름에서 UserCredential을 반환합니다.
initializeRecaptchaConfig(auth) reCAPTCHA 구성을 Auth 인스턴스에 로드합니다.
isSignInWithEmailLink(auth, emailLink) 수신 링크가 signInWithEmailLink()에 적합한 이메일 링크가 있는 로그인인지 확인합니다.
onAuthStateChanged(auth, nextOrObserver, error, completed) 사용자의 로그인 상태 변경사항을 관찰하는 관찰자를 추가합니다.
onIdTokenChanged(auth, nextOrObserver, error, completed) 로그인한 사용자의 ID 토큰 변경사항을 관찰하는 관찰자를 추가합니다.
revokeAccessToken(auth, token) 지정된 액세스 토큰을 취소합니다. 현재 Apple OAuth 액세스 토큰만 지원합니다.
sendPasswordResetEmail(auth, email, actionCodeSettings) 지정된 이메일 주소로 비밀번호 재설정 이메일을 보냅니다. 이 방법을 사용하면 지정된 이메일 주소를 가진 사용자 계정이 없고 [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)가 사용 설정된 경우 오류가 발생하지 않습니다.
sendSignInLinkToEmail(auth, email, actionCodeSettings) 지정된 이메일이 있는 사용자에게 로그인 이메일 링크를 보냅니다.
setPersistence(auth, persistence) 현재 저장된 Auth 세션의 Auth 인스턴스에서 지속성 유형을 변경하고 리디렉션 요청을 사용한 로그인을 포함하여 향후 로그인 요청에 이러한 지속성 유형을 적용합니다.
signInAnonymously(auth) 익명 사용자로 비동기적으로 로그인합니다.
signInWithCredential(auth, credential) 지정된 사용자 인증 정보로 비동기적으로 로그인합니다.
signInWithCustomToken(auth, customToken) 커스텀 토큰을 사용하여 비동기적으로 로그인합니다.
signInWithEmailAndPassword(auth, email, password) 이메일과 비밀번호를 사용하여 비동기적으로 로그인합니다.
signInWithEmailLink(auth, email, emailLink) 이메일 및 로그인 이메일 링크를 사용하여 비동기적으로 로그인합니다.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) 전화번호를 사용하여 비동기적으로 로그인합니다.
signInWithPopup(auth, provider, resolver) 팝업 기반 OAuth 인증 흐름을 사용하여 Firebase 클라이언트를 인증합니다.
signInWithRedirect(auth, provider, resolver) 전체 페이지 리디렉션 흐름을 사용하여 Firebase 클라이언트를 인증합니다.
signOut(auth) 현재 사용자를 로그아웃시킵니다.
updateCurrentUser(auth, user) 비동기적으로 제공된 사용자를 Auth 인스턴스에서 Auth.currentUser로 설정합니다.
useDeviceLanguage(auth) 현재 언어를 기본 기기/브라우저 환경설정으로 설정합니다.
validatePassword(auth, password) 프로젝트 또는 테넌트에 구성된 비밀번호 정책을 기준으로 비밀번호의 유효성을 검사합니다.
verifyPasswordResetCode(auth, code) 이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 비밀번호 재설정 코드를 확인합니다.
함수(링크, ...)
parseActionCodeURL(링크) 이메일 작업 링크 문자열을 파싱하여 링크가 유효하면 ActionCodeURL을 반환하고 그렇지 않으면 null을 반환합니다.
함수(사용자, ...)
deleteUser(user) 사용자를 삭제하고 로그아웃시킵니다.
getIdToken(user, forceRefresh) Firebase 서비스에서 사용자를 식별하는 데 사용되는 JSON 웹 토큰 (JWT)을 반환합니다.
getIdTokenResult(user, forceRefresh) Firebase 서비스에서 사용자를 식별하는 데 사용되는 역직렬화된 JSON 웹 토큰 (JWT)을 반환합니다.
linkWithCredential(user, credential) 사용자 계정을 지정된 사용자 인증 정보와 연결합니다.
linkWithPhoneNumber(user, phoneNumber, appVerifier) 사용자 계정을 지정된 전화번호와 연결합니다.
linkWithPopup(user, provider, resolver) 팝업 기반 OAuth 흐름을 사용하여 인증된 제공업체를 사용자 계정에 연결합니다.
linkWithRedirect(user, provider, resolver) 전체 페이지 리디렉션 흐름을 사용하여 OAuthProvider를 사용자 계정에 연결합니다.
multiFactor(user) 사용자에 해당하는 MultiFactorUser입니다.
reauthenticateWithCredential(user, credential) 새로운 사용자 인증 정보를 사용하여 사용자를 다시 인증합니다.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) 새로운 전화 사용자 인증 정보를 사용하여 사용자를 다시 인증합니다.
reauthenticateWithPopup(user, provider, resolver) 팝업 기반 OAuth 흐름을 사용하여 지정된 OAuthProvider로 현재 사용자를 다시 인증합니다.
reauthenticateWithRedirect(user, provider, resolver) 전체 페이지 리디렉션 흐름을 사용하여 지정된 OAuthProvider로 현재 사용자를 다시 인증합니다.
reload(사용자) 로그인한 경우 사용자 계정 데이터를 새로고침합니다.
sendEmailVerification(user, actionCodeSettings) 사용자에게 확인 이메일을 보냅니다.
unlink(사용자, 제공업체 ID) 공급업체와 사용자 계정의 연결을 해제합니다.
updateEmail(user, newEmail) 사용자의 이메일 주소를 업데이트합니다.
updatePassword(user, newPassword) 사용자의 비밀번호를 업데이트합니다.
updatePhoneNumber(user, credential) 사용자의 전화번호를 업데이트합니다.
updateProfile(user, { displayName, photoURL: photoUrl }) 사용자의 프로필 데이터를 업데이트합니다.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) 새 이메일 주소로 확인 이메일을 보냅니다.
function(userCredential, ...)
getAdditionalUserInfo(userCredential) 지정된 사용자 인증 정보의 제공업체별 AdditionalUserInfo를 추출합니다.

클래스

클래스 설명
ActionCodeURL 비밀번호 재설정, 이메일 확인, 이메일 링크 로그인 등의 이메일 작업 URL을 파싱하는 유틸리티 클래스입니다.
AuthCredential AuthProvider에서 반환한 사용자 인증 정보를 나타내는 인터페이스입니다.
EmailAuthCredential ProviderId에 대해 EmailAuthProvider에서 반환한 사용자 인증 정보를 나타내는 인터페이스입니다.
EmailAuthProvider EmailAuthCredential을 생성하는 제공업체입니다.
FacebookAuthProvider ProviderId.FACEBOOK의 OAuthCredential을 생성하는 제공업체입니다.
GithubAuthProvider ProviderId.GITHUB의 OAuthCredential을 생성하는 제공업체입니다.
GoogleAuthProvider ProviderId.GOOGLE의 OAuthCredential을 생성하는 제공업체입니다.
OAuthCredential OAuthProvider에서 반환한 OAuth 사용자 인증 정보를 나타냅니다.
OAuthProvider 일반 OAuthCredential을 생성하기 위한 제공자입니다.
PhoneAuthCredential PhoneAuthProvider에서 반환한 사용자 인증 정보를 나타냅니다.
PhoneAuthProvider PhoneAuthCredential을 생성하는 제공업체입니다.
PhoneMultiFactorGenerator PhoneMultiFactorAssertion을 생성하는 제공자입니다.
RecaptchaVerifier reCAPTCHA 기반 애플리케이션 인증기
SAMLAuthProvider SAML용 AuthProvider입니다.
TotpMultiFactorGenerator TotpMultiFactorAssertion을 생성하는 제공자입니다.
TotpSecret TotpMultiFactorAssertion을 생성하는 제공업체입니다.공유 보안 비밀 키와 기타 매개변수를 저장하여 시간 기반 OTP를 생성합니다. 공유 비밀번호 키를 검색하고 QR 코드 URL을 생성하는 메서드를 구현합니다.
TwitterAuthProvider ProviderId.TWITTER의 OAuthCredential을 생성하는 제공업체입니다.

인터페이스

인터페이스 설명
ActionCodeInfo checkActionCode()의 응답입니다.
ActionCodeSettings 선택적 Android 및 iOS 번들 식별자와 함께 필수 연결/상태 URL을 정의하는 인터페이스입니다.
AdditionalUserInfo 제휴 ID 공급업체의 추가 사용자 정보가 포함된 구조입니다.
ApplicationVerifier 도메인 확인 및 악용 방지를 위한 인증 도구입니다.
인증 Firebase 인증 서비스를 나타내는 인터페이스입니다.
AuthError Auth 오류의 인터페이스입니다.
AuthErrorMap 오류 코드의 매핑입니다.
AuthProvider 인증 제공업체를 나타내는 인터페이스로 AuthCredential 생성을 용이하게 하는 데 사용됩니다.
AuthSettings Auth 인스턴스의 설정을 나타내는 인터페이스입니다.
구성 Auth 구성을 나타내는 인터페이스입니다.
ConfirmationResult 전화번호 로그인, 링크 또는 재인증 통화의 결과입니다.
종속 항목 Auth 인스턴스를 초기화하는 데 사용할 수 있는 종속 항목
EmulatorConfig Firebase 인증 에뮬레이터 구성
IdTokenResult User.getIdTokenResult()에서 가져온 ID 토큰 결과를 나타내는 인터페이스입니다.
MultiFactorAssertion 두 번째 단계의 소유권을 어설션하는 기본 클래스입니다.
MultiFactorError 사용자가 성공적으로 로그인하기 위해 두 번째 단계를 제공해야 할 때 발생하는 오류입니다.
MultiFactorInfo 두 번째 요소 항목의 정보가 포함된 구조입니다.
MultiFactorResolver 사용자가 로그인하기 위해 두 번째 단계를 제공해야 하는 경우 MultiFactorError 복구를 용이하게 하는 데 사용되는 클래스입니다.
MultiFactorSession 사용자의 두 번째 단계를 등록하거나 두 번째 단계로 등록된 사용자의 로그인을 지원하는 데 사용되는 다단계 세션 객체를 정의하는 인터페이스입니다.
MultiFactorUser User와 관련된 다단계 관련 속성 및 작업을 정의하는 인터페이스입니다.
OAuthCredentialOptions OAuthCredential 초기화 옵션을 정의합니다.
ParsedToken 파싱된 ID 토큰을 나타내는 인터페이스입니다.
PasswordPolicy 비밀번호 정책 요구사항을 지정하는 구조입니다.
PasswordValidationStatus 충족되거나 위반한 비밀번호 정책 요구사항 및 요구사항을 나타내는 구조
지속성 가능한 지속성 메커니즘 유형을 다루는 인터페이스입니다.
PhoneMultiFactorAssertion 전화 두 번째 단계의 소유권을 어설션하는 클래스입니다. PhoneMultiFactorGenerator.assertion()에서 제공합니다.
PhoneMultiFactorEnrollInfoOptions 두 번째 단계를 등록하는 데 사용되는 옵션입니다.
PhoneMultiFactorInfo 전화번호 2단계에 대한 MultiFactorInfo 인터페이스의 서브클래스입니다. 이 두 번째 단계의 factorId는 FactorId.PHONE입니다.
PhoneMultiFactorSignInInfoOptions 두 번째 단계로 로그인하는 데 사용되는 옵션입니다.
PhoneSingleFactorInfoOptions 단일 인증 로그인에 사용되는 옵션입니다.
PopupRedirectResolver signInWithPopup() 또는 signInWithRedirect()와 같은 DOM 관련 작업을 처리하는 데 사용되는 리졸버입니다.
ReactNativeAsyncStorage 제공된 AsyncStorage의 인터페이스입니다.
RecaptchaParameters reCAPTCHA 매개변수를 나타내는 인터페이스입니다.허용되는 매개변수 목록은 [reCAPTCHA 문서](https://developers.google.com/recaptcha/docs/display#render_param)를 참조하세요. sitekey를 제외한 모든 매개변수가 허용됩니다. Firebase 인증은 각 프로젝트에 reCAPTCHA를 프로비저닝하고 렌더링 시 사이트 키를 구성합니다.보이지 않는 reCAPTCHA의 경우 size 키를 invisible로 설정합니다.
TotpMultiFactorAssertion TOTP 두 번째 단계의 소유권을 주장하는 클래스입니다. TotpMultiFactorGenerator.assertionForEnrollment() 및 TotpMultiFactorGenerator.assertionForSignIn()에서 제공합니다.
TotpMultiFactorInfo TOTP 2단계 인증의 MultiFactorInfo 인터페이스의 서브클래스입니다. 이 두 번째 단계의 factorId는 FactorId.TOTP입니다.
사용자(User) 사용자 계정.
UserCredential User, OperationType, 제공업체 ID가 포함된 구조
UserInfo Firebase 프로젝트의 앱에만 표시되는 사용자 프로필 정보입니다.
UserMetadata 사용자의 메타데이터를 나타내는 인터페이스입니다.

변수

변수 설명
ActionCodeOperation 가능한 이메일 작업 유형의 열거형입니다.
AuthErrorCodes SDK에서 발생한 오류를 쉽게 비교할 수 있는 잠재적인 Auth 오류 코드의 맵입니다.
browserLocalPersistence 기본 저장소에 localStorage를 사용하여 LOCAL 유형의 지속성을 구현합니다.
browserPopupRedirectResolver 브라우저 기반 애플리케이션에 적합한 PopupRedirectResolver 구현.
browserSessionPersistence 기본 저장소에 sessionStorage를 사용하여 SESSION의 지속성을 구현합니다.
cordovaPopupRedirectResolver Cordova 기반 애플리케이션에 적합한 PopupRedirectResolver 구현입니다.
debugErrorMap 대부분의 오류 코드에 대한 자세한 설명이 포함된 상세 오류 맵입니다.AuthErrorMap에서 토론을 확인하세요.
FactorId 다중 인증(MFA)에 사용할 수 있는 요소의 열거형입니다.
indexedDBLocalPersistence 기본 저장소에 indexedDB를 사용하여 LOCAL 유형의 지속성을 구현합니다.
inMemoryPersistence 'NONE' 유형의 지속성 구현
OperationType 지원되는 작업 유형의 열거형입니다.
prodErrorMap 모든 상세 오류 메시지가 제거된 최소 오류 맵입니다.AuthErrorMap에서 토론 보기
ProviderId 지원되는 제공업체의 열거형입니다.
SignInMethod 지원되는 로그인 방법의 열거형입니다.

유형 별칭

유형 별칭 설명
CustomParameters OAuth 맞춤 매개변수 맵입니다.
NextOrObserver 이벤트 콜백의 유형 정의입니다.
PhoneInfoOptions 전화번호의 소유권을 확인하는 데 필요한 정보
UserProfile AdditionalUserInfo에 사용되는 사용자 프로필입니다.

function(앱, ...)

getAuth(app)

제공된 FirebaseApp과 연결된 Auth 인스턴스를 반환합니다. 인스턴스가 없으면 플랫폼별 기본 종속 항목이 있는 Auth 인스턴스를 초기화합니다.

Signature:

export declare function getAuth(app?: FirebaseApp): Auth;

매개변수

매개변수 유형 설명
앱 FirebaseApp Firebase 앱

반환:

인증

initializeAuth(app, deps)

종속 항목을 세밀하게 제어하여 Auth 인스턴스를 초기화합니다.

이 함수를 사용하면 getAuth()보다 Auth 인스턴스를 더 세밀하게 제어할 수 있습니다. getAuth는 플랫폼별 기본값을 사용하여 종속 항목을 제공합니다. 일반적으로 인증을 초기화하는 가장 쉬운 방법은 getAuth이며 대부분의 사용 사례에 적합합니다. 사용되는 지속성 레이어를 제어해야 하는 경우 initializeAuth를 사용하고 signInWithPopup 또는 signInWithRedirect를 사용하지 않는 경우 번들 크기를 최소화하려면 initializeAuth를 사용합니다.

예를 들어 앱에서 익명 계정만 사용하고 현재 세션에 관해서만 저장하고자 하는 경우 다음과 같이 Auth를 초기화합니다.

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

Signature:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

매개변수

매개변수 유형 설명
앱 FirebaseApp
deps 종속 항목

반환:

인증

function(storage, ...)

getReactNativePersistence(storage)

react-native 또는 @react-native-community/async-storage에서 가져온 AsyncStorage를 래핑하는 지속성 객체를 반환하며, initializeAuth()의 지속성 종속 항목 필드에서 사용할 수 있습니다.

Signature:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

매개변수

매개변수 유형 설명
저장용량 ReactNativeAsyncStorage

반환:

지속성

function(auth, ...)

applyActionCode(auth, oobCode)

이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 인증 코드를 적용합니다.

Signature:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
oobCode 문자열 사용자에게 인증 코드가 전송됩니다.

반환:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

인증 상태 변경으로 신규 사용자를 설정하기 전에 실행되는 차단 콜백을 추가합니다.

Signature:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
콜백 (user: User | null) => void | Promise<void> 콜백이 호출됩니다. 이 경우 사용자가 설정되지 못하도록 차단합니다.
onAbort () => void 콜백이 트리거되어 부작용을 실행취소할 수 있도록 나중에 beforeAuthStateChanged() 콜백이 발생할 때 트리거됩니다.

반환:

수신 거부

checkActionCode(auth, oobCode)

이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 인증 코드를 확인합니다.

Signature:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
oobCode 문자열 사용자에게 인증 코드가 전송됩니다.

반환:

Promise<ActionCodeInfo>

코드에 대한 메타데이터입니다.

confirmPasswordReset(auth, oobCode, newPassword)

확인 코드와 새 비밀번호를 입력하여 비밀번호 재설정 프로세스를 완료합니다.

Signature:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
oobCode 문자열 사용자에게 전송되는 확인 코드입니다.
newPassword 문자열 새 비밀번호입니다.

반환:

Promise<void>

connectAuthEmulator(auth, url, options)

프로덕션 Firebase 인증 서비스가 아닌 Firebase 인증 에뮬레이터와 통신하도록 Auth 인스턴스를 변경합니다.

이 메서드는 initializeAuth()에 대한 첫 번째 호출 직후에 동기식으로 호출해야 합니다. 에뮬레이터 트래픽이 암호화되지 않으므로 프로덕션 사용자 인증 정보와 함께 사용하지 마세요.

Signature:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
url 문자열 에뮬레이터가 실행 중인 URL입니다 (예: 'http://localhost:9099').
옵션 { disableWarnings: boolean; } 선택사항입니다. options.disableWarnings 기본값은 false입니다. DOM에 연결된 경고 배너를 사용 중지하려면 true로 설정합니다.

반환:

void

예

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, email, password)

지정된 이메일 주소 및 비밀번호와 연결된 새 사용자 계정을 만듭니다.

사용자 계정이 생성되면 이 사용자도 애플리케이션에 로그인됩니다.

계정이 이미 있거나 비밀번호가 잘못된 경우 사용자 계정을 만들지 못할 수 있습니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
이메일 문자열 사용자의 이메일 주소
비밀번호 문자열 사용자가 선택한 비밀번호입니다.

반환:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

지정된 이메일 주소에 사용할 수 있는 로그인 방법의 목록을 가져옵니다. 이 메서드는 지정된 이메일에 사용할 수 있는 인증 방법의 수에 관계없이 [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)가 사용 설정된 경우 빈 목록을 반환합니다.

이는 동일한 제공업체의 로그인 방법을 구분하는 데 유용합니다(예: EmailAuthProvider에는 SignInMethod.EMAIL_PASSWORD와 SignInMethod.EMAIL_LINK 등 두 가지 로그인 방법이 있습니다.

Signature:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
이메일 문자열 사용자의 이메일 주소입니다.지원 중단되었습니다. 보안 권장사항으로 이 방법에서 이전하는 것이 좋습니다. [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)에 대한 Identity Platform 문서에서 자세히 알아보세요.

반환:

프로미스<string[]>

getMultiFactorResolver(auth, error)

다단계 흐름을 완료하는 데 적합한 MultiFactorResolver를 제공합니다.

Signature:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
error MultiFactorError 로그인 또는 재인증 작업 중에 발생하는 MultiFactorError입니다.

반환:

MultiFactorResolver

getRedirectResult(auth, resolver)

리디렉션 기반 로그인 흐름에서 UserCredential을 반환합니다.

로그인이 성공하면 로그인한 사용자를 반환합니다. 로그인에 실패하면 오류와 함께 실패합니다. 리디렉션 작업이 호출되지 않으면 null이 반환됩니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

Promise<UserCredential | null>

예

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

initializeRecaptchaConfig(auth)

reCAPTCHA 구성을 Auth 인스턴스에 로드합니다.

이렇게 하면 각 인증 제공업체의 reCAPTCHA 인증 흐름을 트리거해야 하는지 여부를 나타내는 reCAPTCHA 구성이 현재 인증 세션에 로드됩니다.

initializeRecaptchaConfig()가 호출되지 않으면 항상 reCAPTCHA 인증 없이 인증 흐름이 시작됩니다. 제공업체가 reCAPTCHA 인증을 요구하도록 구성된 경우 SDK는 reCAPTCHA 구성을 투명하게 로드하고 인증 흐름을 다시 시작합니다.

따라서 이 선택적 메서드를 호출하면 향후 인증 흐름의 지연 시간을 줄일 수 있습니다. reCAPTCHA 구성을 조기에 로드하면 reCAPTCHA에서 수집하는 신호도 향상됩니다.

이 메서드는 Node.js 환경에서 작동하지 않습니다.

Signature:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.

반환:

Promise<void>

예

initializeRecaptchaConfig(auth);

수신 링크가 signInWithEmailLink()에 적합한 이메일 링크가 있는 로그인인지 확인합니다.

Signature:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
emailLink 문자열 사용자의 이메일 주소로 전송된 링크입니다.

반환:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

사용자의 로그인 상태 변경사항을 관찰하는 관찰자를 추가합니다.

이전 동작을 유지하려면 onIdTokenChanged()를 참조하세요.

Signature:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
nextOrObserver NextOrObserver<사용자> 변경 시 트리거되는 콜백입니다.
error ErrorFn 지원이 중단되었습니다. 이 콜백은 트리거되지 않습니다. 로그인/로그아웃 시 발생하는 오류는 로그인/로그아웃 함수에서 반환된 프로미스에서 포착할 수 있습니다.
완료됨 CompleteFn 지원이 중단되었습니다. 이 콜백은 트리거되지 않습니다.

반환:

수신 거부

onIdTokenChanged(auth, nextOrObserver, error, completed)

로그인한 사용자의 ID 토큰 변경사항을 관찰하는 관찰자를 추가합니다.

여기에는 로그인, 로그아웃, 토큰 새로고침 이벤트가 포함됩니다. ID 토큰이 만료될 때 자동으로 트리거되지 않습니다. User.getIdToken()을 사용하여 ID 토큰을 새로고침합니다.

Signature:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
nextOrObserver NextOrObserver<사용자> 변경 시 트리거되는 콜백입니다.
error ErrorFn 지원이 중단되었습니다. 이 콜백은 트리거되지 않습니다. 로그인/로그아웃 시 발생하는 오류는 로그인/로그아웃 함수에서 반환된 프로미스에서 포착할 수 있습니다.
완료됨 CompleteFn 지원이 중단되었습니다. 이 콜백은 트리거되지 않습니다.

반환:

수신 거부

revokeAccessToken(auth, token)

지정된 액세스 토큰을 취소합니다. 현재 Apple OAuth 액세스 토큰만 지원합니다.

Signature:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
토큰 문자열 Apple OAuth 액세스 토큰입니다.

반환:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

지정된 이메일 주소로 비밀번호 재설정 이메일을 보냅니다. 이 방법을 사용하면 지정된 이메일 주소를 가진 사용자 계정이 없고 [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)가 사용 설정된 경우 오류가 발생하지 않습니다.

비밀번호 재설정을 완료하려면 사용자에게 전송된 이메일에 제공된 코드와 사용자가 지정한 새 비밀번호를 사용하여 confirmPasswordReset()을 호출합니다.

Signature:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
이메일 문자열 사용자의 이메일 주소
actionCodeSettings ActionCodeSettings ActionCodeSettings입니다.

반환:

Promise<void>

예

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

지정된 이메일이 있는 사용자에게 로그인 이메일 링크를 보냅니다.

다른 대역 외 이메일 작업 (비밀번호 재설정 및 이메일 인증)과 달리 이 로그인 작업은 항상 앱에서 완료해야 합니다. 그 이유는 인증 절차의 마지막에 사용자가 로그인하고 사용자의 인증 상태를 앱에서 유지해야 하기 때문입니다.

이메일 링크로 로그인을 완료하려면 사용자에게 보낸 이메일에 제공된 이메일 주소와 이메일 링크를 사용하여 signInWithEmailLink()를 호출합니다.

Signature:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증
이메일 문자열 사용자의 이메일 주소
actionCodeSettings ActionCodeSettings ActionCodeSettings입니다.

반환:

Promise<void>

예

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, persistence)

현재 저장된 Auth 세션의 Auth 인스턴스에서 지속성 유형을 변경하고 리디렉션 요청을 사용한 로그인을 포함하여 향후 로그인 요청에 이러한 지속성 유형을 적용합니다.

이렇게 하면 로그인한 사용자가 세션을 기억할지 여부를 쉽게 지정할 수 있습니다. 또한 다른 사용자가 공유하거나 민감한 정보가 있는 애플리케이션에서는 Auth 상태를 절대로 유지하지 않기도 합니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
지속성 지속성 사용할 지속성입니다.

반환:

Promise<void>

지속성 변경이 완료되면 해결되는 Promise입니다.

예

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

익명 사용자로 비동기적으로 로그인합니다.

이미 로그인한 익명 사용자가 있으면 해당 사용자가 반환됩니다. 그렇지 않으면 새 익명 사용자 ID가 생성되어 반환됩니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.

반환:

Promise<UserCredential>

signInWithCredential(auth, credential)

지정된 사용자 인증 정보로 비동기적으로 로그인합니다.

AuthProvider를 사용하여 사용자 인증 정보를 생성할 수 있습니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
사용자 인증정보 AuthCredential 인증 사용자 인증 정보입니다.

반환:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

커스텀 토큰을 사용하여 비동기적으로 로그인합니다.

맞춤 토큰은 Firebase 인증을 기존 인증 시스템과 통합하는 데 사용되며, 인증 백엔드에서 Admin SDK의 createCustomToken 메서드를 사용하여 생성해야 합니다 .

토큰이 유효하지 않거나, 만료되었거나, Firebase 인증 서비스에서 수락하지 않으면 오류가 발생합니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
customToken 문자열 로그인에 사용할 커스텀 토큰입니다.

반환:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

이메일과 비밀번호를 사용하여 비동기적으로 로그인합니다.

이메일 주소와 비밀번호가 일치하지 않으면 오류가 발생합니다. [이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)를 사용 설정하면 이메일/비밀번호가 잘못된 경우 'auth/invalid-credential'이 표시되면서 이 메서드가 실패하게 됩니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
이메일 문자열 사용자 이메일 주소입니다.
비밀번호 문자열 사용자 비밀번호입니다.

반환:

Promise<UserCredential>

이메일 및 로그인 이메일 링크를 사용하여 비동기적으로 로그인합니다.

전달된 링크가 없으면 현재 URL에서 링크가 유추됩니다.

이메일 주소가 잘못되었거나 이메일 링크의 OTP가 만료된 경우 오류가 발생합니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
이메일 문자열 사용자의 이메일 주소
emailLink 문자열 사용자의 이메일 주소로 전송된 링크입니다.

반환:

Promise<UserCredential>

예

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

전화번호를 사용하여 비동기적으로 로그인합니다.

이 메서드는 지정된 전화번호로 SMS를 통해 코드를 전송하고 ConfirmationResult를 반환합니다. 사용자가 휴대전화로 전송된 코드를 제공하면 코드를 사용해 ConfirmationResult.confirm()을 호출하여 사용자를 로그인 처리합니다.

악용을 방지하기 위해 이 메서드에는 ApplicationVerifier도 필요합니다. 이 SDK에는 reCAPTCHA 기반 구현인 RecaptchaVerifier가 포함되어 있습니다. 이 함수는 RecaptchaVerifier (예: React Native)를 지원하지 않는 다른 플랫폼에서 작동할 수 있지만, 서드 파티 ApplicationVerifier 구현을 사용해야 합니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
phoneNumber 문자열 E.164 형식 (예: +16505550101)의 사용자 전화번호입니다.
appVerifier ApplicationVerifier ApplicationVerifier

반환:

Promise<ConfirmationResult>

예

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(auth, provider, resolver)

팝업 기반 OAuth 인증 흐름을 사용하여 Firebase 클라이언트를 인증합니다.

성공하면 제공업체의 사용자 인증 정보와 함께 로그인한 사용자를 반환합니다. 로그인에 실패하면 오류에 대한 추가 정보가 포함된 오류 객체를 반환합니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

Promise<UserCredential>

예

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(auth, provider, resolver)

전체 페이지 리디렉션 흐름을 사용하여 Firebase 클라이언트를 인증합니다.

이 작업의 결과 및 오류를 처리하려면 getRedirectResult()를 참조하세요. signInWithRedirect()를 사용할 때는 권장사항을 따르세요.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

프로미스<절대>

예

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(auth)

현재 사용자를 로그아웃시킵니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function signOut(auth: Auth): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.

반환:

Promise<void>

updateCurrentUser(auth, user)

비동기적으로 제공된 사용자를 Auth 인스턴스에서 Auth.currentUser로 설정합니다.

제공된 사용자의 새 인스턴스 사본이 생성되고 currentUser로 설정됩니다.

이렇게 하면 다른 로그인 메서드와 마찬가지로 onAuthStateChanged() 및 onIdTokenChanged() 리스너가 트리거됩니다.

업데이트할 사용자가 다른 Firebase 프로젝트에 속해 있으면 오류가 발생하고 작업이 실패합니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스에서 지원되지 않습니다.

Signature:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
사용자 사용자 | null 새 사용자입니다.

반환:

Promise<void>

useDeviceLanguage(auth)

현재 언어를 기본 기기/브라우저 환경설정으로 설정합니다.

Signature:

export declare function useDeviceLanguage(auth: Auth): void;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.

반환:

void

validatePassword(auth, password)

프로젝트 또는 테넌트에 구성된 비밀번호 정책을 기준으로 비밀번호의 유효성을 검사합니다.

Auth 인스턴스에 설정된 테넌트 ID가 없으면 이 메서드는 프로젝트에 구성된 비밀번호 정책을 사용합니다. 그렇지 않으면 이 메서드는 테넌트에 구성된 정책을 사용합니다. 비밀번호 정책이 구성되지 않은 경우 모든 프로젝트에 구성된 기본 정책이 사용됩니다.

제출된 비밀번호가 비밀번호 정책 요구사항을 충족하지 않고 이 메서드가 이전에 호출되어 인증 흐름이 실패하면 이 메서드는 다시 호출할 때 사용 가능한 최신 정책을 사용합니다.

Signature:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
비밀번호 문자열 확인할 비밀번호입니다.

반환:

Promise<PasswordValidationStatus>

예

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

이메일 또는 기타 대역 외 메커니즘을 통해 사용자에게 전송된 비밀번호 재설정 코드를 확인합니다.

Signature:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

매개변수

매개변수 유형 설명
auth 인증 Auth 인스턴스입니다.
코드 문자열 사용자에게 인증 코드가 전송됩니다.

반환:

프로미스<string>

사용자의 이메일 주소입니다(유효한 경우).

function(link, ...)

parseActionCodeURL(링크)

이메일 작업 링크 문자열을 파싱하여 링크가 유효하면 ActionCodeURL을 반환하고 그렇지 않으면 null을 반환합니다.

Signature:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

매개변수

매개변수 유형 설명
링크 문자열

반환:

ActionCodeURL | null

function(사용자, ...)

deleteUser(user)

사용자를 삭제하고 로그아웃시킵니다.

Signature:

export declare function deleteUser(user: User): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.

반환:

Promise<void>

getIdToken(user, forceRefresh)

Firebase 서비스에서 사용자를 식별하는 데 사용되는 JSON 웹 토큰 (JWT)을 반환합니다.

현재 토큰이 만료되지 않았거나 다음 5분 이내에 만료되지 않으면 현재 토큰을 반환합니다. 그렇지 않으면 토큰이 새로고침되고 새 토큰이 반환됩니다.

Signature:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
forceRefresh boolean 토큰 만료와 관계없이 강제 새로고침

반환:

프로미스<string>

getIdTokenResult(user, forceRefresh)

Firebase 서비스에서 사용자를 식별하는 데 사용되는 역직렬화된 JSON 웹 토큰 (JWT)을 반환합니다.

현재 토큰이 만료되지 않았거나 다음 5분 이내에 만료되지 않으면 현재 토큰을 반환합니다. 그렇지 않으면 토큰이 새로고침되고 새 토큰이 반환됩니다.

Signature:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
forceRefresh boolean 토큰 만료와 관계없이 강제 새로고침

반환:

Promise<IdTokenResult>

linkWithCredential(user, credential)

사용자 계정을 지정된 사용자 인증 정보와 연결합니다.

AuthProvider를 사용하여 사용자 인증 정보를 생성할 수 있습니다.

Signature:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
사용자 인증정보 AuthCredential 인증 사용자 인증 정보입니다.

반환:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

사용자 계정을 지정된 전화번호와 연결합니다.

이 메서드는 Node.js 환경에서 작동하지 않습니다.

Signature:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
phoneNumber 문자열 E.164 형식 (예: +16505550101)의 사용자 전화번호입니다.
appVerifier ApplicationVerifier ApplicationVerifier

반환:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

팝업 기반 OAuth 흐름을 사용하여 인증된 제공업체를 사용자 계정에 연결합니다.

연결에 성공하면 반환된 결과에 사용자 및 제공업체의 사용자 인증 정보가 포함됩니다.

이 메서드는 Node.js 환경에서 작동하지 않습니다.

Signature:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

Promise<UserCredential>

예

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(user, provider, resolver)

전체 페이지 리디렉션 흐름을 사용하여 OAuthProvider를 사용자 계정에 연결합니다.

이 작업의 결과 및 오류를 처리하려면 getRedirectResult()를 참조하세요. linkWithRedirect()를 사용할 때는 권장사항을 따르세요.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

프로미스<절대>

예

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

multiFactor(user)

사용자에 해당하는 MultiFactorUser입니다.

이는 사용자와 관련된 모든 다단계 속성 및 작업에 액세스하는 데 사용됩니다.

Signature:

export declare function multiFactor(user: User): MultiFactorUser;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.

반환:

MultiFactorUser

reauthenticateWithCredential(user, credential)

새로운 사용자 인증 정보를 사용하여 사용자를 다시 인증합니다.

최근 로그인 시도의 토큰이 필요한 updatePassword()와 같은 작업 전에 사용합니다. 이 메서드는 CREDENTIAL_TOO_OLD_LOGIN_AGAIN 오류나 TOKEN_EXPIRED 오류에서 복구하는 데 사용할 수 있습니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스로 로그인한 User에서는 지원되지 않습니다.

Signature:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
사용자 인증정보 AuthCredential 인증 사용자 인증 정보입니다.

반환:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

새로운 전화 사용자 인증 정보를 사용하여 사용자를 다시 인증합니다.

최근 로그인 시도의 토큰이 필요한 updatePassword()와 같은 작업 전에 사용합니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스로 로그인한 User에서는 작동하지 않습니다.

Signature:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
phoneNumber 문자열 E.164 형식 (예: +16505550101)의 사용자 전화번호입니다.
appVerifier ApplicationVerifier ApplicationVerifier

반환:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

팝업 기반 OAuth 흐름을 사용하여 지정된 OAuthProvider로 현재 사용자를 다시 인증합니다.

재인증에 성공하면 반환되는 결과에 사용자 및 제공업체의 사용자 인증 정보가 포함됩니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스로 로그인한 User에서는 작동하지 않습니다.

Signature:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

Promise<UserCredential>

예

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(user, provider, resolver)

전체 페이지 리디렉션 흐름을 사용하여 지정된 OAuthProvider로 현재 사용자를 다시 인증합니다.

이 작업의 결과 및 오류를 처리하려면 getRedirectResult()를 참조하세요. reauthenticateWithRedirect()를 사용할 때는 권장사항을 따르세요.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스에서 작동하지 않습니다.

Signature:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
provider AuthProvider 인증할 제공업체입니다. 제공업체는 OAuthProvider여야 합니다. EmailAuthProvider와 같이 OAuth를 사용하지 않는 제공업체의 경우 오류가 발생합니다.
리졸버 PopupRedirectResolver PopupRedirectResolver의 인스턴스입니다. 이미 initializeAuth()에 제공했거나 getAuth()에서 제공된 경우에는 선택사항입니다.

반환:

프로미스<절대>

예

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

새로고침(사용자)

로그인한 경우 사용자 계정 데이터를 새로고침합니다.

Signature:

export declare function reload(user: User): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.

반환:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

사용자에게 확인 이메일을 보냅니다.

인증 절차는 applyActionCode()를 호출하여 완료됩니다.

Signature:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
actionCodeSettings ActionCodeSettings | null ActionCodeSettings입니다.

반환:

Promise<void>

예

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

공급업체와 사용자 계정의 연결을 해제합니다.

Signature:

export declare function unlink(user: User, providerId: string): Promise<User>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
providerId 문자열 연결을 해제할 제공업체입니다.

반환:

프로미스<사용자>

updateEmail(user, newEmail)

사용자의 이메일 주소를 업데이트합니다.

계정 도용으로부터 사용자를 보호하기 위해 이메일 주소 변경을 취소할 수 있는 이메일이 원래 이메일 주소 (설정된 경우)로 전송됩니다.

이 메서드는 FirebaseServerApp으로 만든 Auth 인스턴스로 로그인한 User에서는 지원되지 않습니다.

Signature:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
newEmail 문자열 새 이메일 주소입니다.[이메일 열거 보호](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)가 사용 설정되면 'auth/operation-not-allowed' 오류가 발생합니다. 지원 중단됨 - verifyBeforeUpdateEmail()을 대신 사용하세요.

반환:

Promise<void>

updatePassword(user, newPassword)

사용자의 비밀번호를 업데이트합니다.

Signature:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
newPassword 문자열 새 비밀번호입니다.

반환:

Promise<void>

updatePhoneNumber(user, credential)

사용자의 전화번호를 업데이트합니다.

이 메서드는 Node.js 환경 또는 FirebaseServerApp으로 만든 Auth 인스턴스로 로그인한 User에서는 작동하지 않습니다.

Signature:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
사용자 인증정보 PhoneAuthCredential 새 전화번호를 인증하는 사용자 인증 정보입니다.

반환:

Promise<void>

예

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(user, { displayName, photoURL: photoUrl })

사용자의 프로필 데이터를 업데이트합니다.

Signature:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
{ 표시 이름, 사진 URL: 사진 URL } { displayName?: string | null; photoURL?: string | null; }

반환:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

새 이메일 주소로 확인 이메일을 보냅니다.

사용자의 이메일이 확인되면 새 이메일로 업데이트됩니다.

맞춤 이메일 작업 핸들러가 있는 경우 applyActionCode()를 호출하여 인증 절차를 완료할 수 있습니다.

Signature:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

매개변수

매개변수 유형 설명
사용자 사용자(User) 사용자입니다.
newEmail 문자열 업데이트하기 전에 확인할 새 이메일 주소입니다.
actionCodeSettings ActionCodeSettings | null ActionCodeSettings입니다.

반환:

Promise<void>

예

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

지정된 사용자 인증 정보의 제공업체별 AdditionalUserInfo를 추출합니다.

Signature:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

매개변수

매개변수 유형 설명
userCredential UserCredential 사용자 인증 정보입니다.

반환:

AdditionalUserInfo | null

ActionCodeOperation

가능한 이메일 작업 유형의 열거형입니다.

Signature:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

SDK에서 발생한 오류를 쉽게 비교할 수 있는 잠재적인 Auth 오류 코드의 맵입니다.

맵에서 개별 키를 트리 쉐이킹할 수 없으므로 맵을 사용하면 번들 크기가 크게 늘어날 수 있습니다.

Signature:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

browserLocalPersistence

기본 저장소에 localStorage를 사용하여 LOCAL 유형의 지속성을 구현합니다.

Signature:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

브라우저 기반 애플리케이션에 적합한 PopupRedirectResolver 구현.

이 메서드는 Node.js 환경에서 작동하지 않습니다.

Signature:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

기본 저장소에 sessionStorage를 사용하여 SESSION의 지속성을 구현합니다.

Signature:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Cordova 기반 애플리케이션에 적합한 PopupRedirectResolver 구현입니다.

Signature:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

대부분의 오류 코드에 대한 자세한 설명이 있는 상세 오류 맵

AuthErrorMap에서 토론 보기

Signature:

debugErrorMap: AuthErrorMap

FactorId

다중 인증(MFA)에 사용할 수 있는 요소의 열거형입니다.

Signature:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexedDBLocalPersistence

기본 저장소에 indexedDB를 사용하여 LOCAL 유형의 지속성을 구현합니다.

Signature:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

'NONE' 유형의 지속성 구현

Signature:

inMemoryPersistence: Persistence

OperationType

지원되는 작업 유형의 열거형입니다.

Signature:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

모든 상세 오류 메시지가 제거된 최소 오류 맵.

AuthErrorMap에서 토론 보기

Signature:

prodErrorMap: AuthErrorMap

ProviderId

지원되는 제공업체의 열거형입니다.

Signature:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

SignInMethod

지원되는 로그인 방법의 열거형입니다.

Signature:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters

OAuth 맞춤 매개변수 맵입니다.

Signature:

export declare type CustomParameters = Record<string, string>;

NextOrObserver

이벤트 콜백의 유형 정의입니다.

Signature:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfoOptions

전화번호의 소유권을 확인하는 데 필요한 정보

필요한 정보는 단일 인증, 다단계 등록, 다단계 로그인 중 무엇을 사용하는지에 따라 다릅니다.

Signature:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

AdditionalUserInfo에 사용되는 사용자 프로필입니다.

Signature:

export declare type UserProfile = Record<string, unknown>;