firebase-admin.auth package

Firebase 인증

Functions

함수 설명
getAuth(앱) 기본 앱 또는 특정 앱의 Auth 서비스를 가져옵니다.getAuth()는 기본 앱의 Auth 서비스에 액세스하기 위한 인수 없이 호출하거나 getAuth(app)로 호출하여 특정 앱과 연결된 Auth 서비스에 액세스할 수 있습니다.

클래스

클래스 설명
인증 제공된 앱에 바인딩된 인증 서비스입니다. 인증 인스턴스에는 여러 테넌트가 있을 수 있습니다.
BaseAuth Auth 및 TenantAwareAuth API의 공통 상위 인터페이스입니다.
다중 요소 정보 사용자가 등록한 두 번째 단계의 일반적인 속성을 나타내는 인터페이스입니다.
MultiFactorSettings 다단계 관련 사용자 설정입니다.
PhoneMultiFactorInfo 휴대전화별 사용자가 등록한 두 번째 단계를 나타내는 인터페이스입니다.
프로젝트 구성 프로젝트 구성을 나타냅니다.
프로젝트 구성 관리자 현재 프로젝트 구성을 관리 (가져오기 및 업데이트)합니다.
테넌트 테넌트 구성을 나타냅니다.멀티테넌시 지원에는 Google Cloud의 Identity Platform (GCIP)이 필요합니다. 가격, 기능을 비롯해 GCIP에 대한 자세한 내용은 GCIP 문서를 참조하세요.Google Cloud Identity Platform 프로젝트에서 멀티테넌시를 사용하려면 Cloud 콘솔 UI를 통해 해당 프로젝트에서 테넌트를 허용해야 합니다.테넌트 구성은 표시 이름, 테넌트 식별자, 이메일 인증 구성과 같은 정보를 제공합니다. OIDC/SAML 제공업체 구성 관리의 경우 Tenant 대신 TenantAwareAuth 인스턴스를 사용하여 테넌트에 구성된 IdP 목록을 가져와야 합니다. 이러한 제공업체를 구성할 때 테넌트는 상위 프로젝트의 허용된 도메인과 인증된 리디렉션 URI를 상속합니다.테넌트의 다른 모든 설정도 상속됩니다. 이러한 작업은 Cloud 콘솔 UI에서 관리해야 합니다.
TenantAwareAuth 사용자 관리, SAML/OIDC 제공업체 구성, 특정 테넌트의 비밀번호 재설정, 이메일 인증 등을 위한 이메일 링크 생성에 사용되는 테넌트 인식 Auth 인터페이스입니다.멀티테넌시 지원을 위해서는 Google Cloud의 Identity Platform (GCIP)이 필요합니다. 가격 및 기능을 비롯해 GCIP에 대한 자세한 내용은 GCIP 문서를 참조하세요.각 테넌트에는 자체 ID 공급업체, 설정, 사용자 집합이 포함됩니다. TenantAwareAuth를 사용하면 특정 테넌트 및 해당 OIDC/SAML 구성도 관리할 수 있고, 특정 테넌트에 로그인한 사용자의 ID 토큰을 확인할 수 있으며, 테넌트에 속한 사용자의 이메일 작업 링크도 생성할 수 있습니다.TenantManager.authForTenant()를 호출하여 특정 tenantId의 TenantAwareAuth 인스턴스를 인스턴스화할 수 있습니다.
테넌트 관리자 테넌트 관련 작업을 관리하는 데 사용되는 테넌트 관리자를 정의합니다. 여기에는 다음과 같은 콘텐츠가 포함됩니다.
  • 기본 프로젝트의 테넌트를 생성, 업데이트, 나열, 가져오기, 삭제할 수 있는 기능
  • 지정된 테넌트의 컨텍스트에서 인증 관련 작업 (사용자 관리, 제공업체 구성 관리, 토큰 확인, 이메일 링크 생성 등)을 실행하기 위한 TenantAwareAuth 인스턴스 가져오기
사용자 정보 Google 또는 Facebook과 같은 서드 파티 ID 공급업체에서 제공한 사용자 정보를 나타냅니다.
UserMetadata 사용자의 메타데이터를 나타냅니다.
UserRecord 사용자를 나타냅니다.

인터페이스

인터페이스 설명
ActionCodeSettings 선택사항인 Android 및 iOS 번들 식별자와 함께 필수 연결/상태 URL을 정의하는 인터페이스입니다.
AllowByDefault 기본적으로 모든 지역을 허용하고 허용되지 않는 지역을 허용 목록에 추가하는 정책을 정의합니다.
AllowByDefaultWrap AllowByDefault 인터페이스의 상호 배타적 SMS 리전 구성
허용 목록 전용 지역을 허용 목록에 명시적으로 추가하여 지역만 허용하는 정책을 정의합니다.
AllowlistOnlyWrap AllowlistOnly 인터페이스의 상호 배타적인 SMS 리전 구성
AuthProviderConfigFilter 비교 제공업체 구성을 나열하는 데 사용되는 필터 인터페이스입니다. BaseAuth.listProviderConfigs()를 통해 구성된 ID 공급업체를 나열하는 방법을 지정할 때 사용됩니다.
BaseAuthProviderConfig. 기본 인증 제공업체 구성 인터페이스입니다.
BaseCreateMultiFactorInfoRequest CreateRequest에 대해 사용자가 등록한 두 번째 단계의 기본 속성을 나타내는 인터페이스입니다.
BaseUpdateMultiFactorInfoRequest UpdateRequest에 대해 사용자가 등록한 두 번째 단계의 일반적인 속성을 나타내는 인터페이스입니다.
CreatePhoneMultiFactorInfoRequest CreateRequest의 휴대전화별 사용자가 등록한 두 번째 단계를 나타내는 인터페이스입니다.
요청 생성 생성될 새 사용자 레코드에 설정할 속성을 나타내는 인터페이스입니다.
커스텀 강도 옵션 구성 비밀번호 정책에 적용할 제약조건
DecodedAuthBlockingToken
DecodingIdToken BaseAuth.verifyIdToken() 메서드에서 반환된 디코딩된 Firebase ID 토큰을 나타내는 인터페이스입니다.Firebase ID 토큰은 OpenID Connect 사양을 준수하는 JSON 웹 토큰 (JWT)입니다. 아래의 특정 속성에 대한 자세한 내용은 [OpenID Connect 사양의 ID 토큰 섹션](http://openid.net/specs/openid-connect-core-1_0.html#IDToken)을 참조하세요.
DeleteUsersResult(삭제 사용자 결과) BaseAuth.deleteUsers(). API의 결과를 나타냅니다.
EmailIdentifier 이메일로 계정을 조회하는 데 사용됩니다.BaseAuth.getUsers()를 참고하세요.
EmailPrivacyConfig를 참조하세요. 프로젝트 또는 테넌트의 이메일 개인 정보 보호 구성입니다.
EmailSignInProviderConfig로 이동합니다. 이메일 로그인 공급업체 구성
GetUsersResult BaseAuth.getUsers() API의 결과를 나타냅니다.
ListProviderConfigResults 제공업체 구성을 나열하기 위한 응답 인터페이스입니다. 이 옵션은 BaseAuth.listProviderConfigs()를 통해 모든 ID 공급업체의 구성을 나열할 때만 사용할 수 있습니다.
ListTenantsResult TenantManager.listTenants() 연산에서 반환된 객체를 나타내는 인터페이스입니다. 현재 배치 및 다음 페이지 토큰(있는 경우)의 테넌트 목록을 포함합니다.
ListUsersResult BaseAuth.listUsers() 작업에서 반환된 객체를 나타내는 인터페이스입니다. 현재 배치 및 다음 페이지 토큰(있는 경우)의 사용자 목록을 포함합니다.
MultiFactorConfig 다단계 구성을 나타내는 인터페이스입니다. 다중 인증(MFA)의 사용 설정 또는 사용 중지 여부와 지원되는 2단계 인증 질문 목록을 정의하는 데 사용할 수 있습니다.
MultiFactorCreateSettings 생성 작업을 위한 다단계 관련 사용자 설정입니다.
MultiFactorProviderConfig 다단계 인증 제공업체 구성을 나타내는 인터페이스입니다. 이 인터페이스는 SMS를 제외한 2단계 인증 제공자에 사용됩니다. 현재는 TOTP만 지원됩니다.
MultiFactorUpdateSettings 업데이트 작업을 위한 다단계 관련 사용자 설정입니다.
OAuthResponseType OAuth 승인 흐름을 위한 OIDC 제공업체의 응답 객체를 나타내는 인터페이스입니다. 다음 설정 중 하나가 필요합니다.
  • 코드 흐름에서 code를 true로 설정합니다.
  • ID 토큰 흐름에서 idToken를 true로 설정합니다.
OIDCAuthProviderConfig [OIDC](https://openid.net/specs/openid-connect-core-1_0-Final.html) 인증 제공업체 구성 인터페이스입니다. OIDC 제공업체는 BaseAuth.createProviderConfig()를 통해 만들 수 있습니다.
OIDCUpdateAuthProviderRequest OIDC 인증 제공업체를 업데이트하기 위한 요청 인터페이스입니다. BaseAuth.updateProviderConfig()를 통해 OIDC 제공업체의 구성을 업데이트할 때 사용됩니다.
PasswordPolicyConfig 프로젝트 또는 테넌트의 비밀번호 정책 구성
PhoneIdentifier 전화번호로 계정을 조회하는 데 사용됩니다.BaseAuth.getUsers()를 참고하세요.
ProviderIdentifier 제휴 제공업체에서 계정을 조회하는 데 사용됩니다.BaseAuth.getUsers()를 참고하세요.
RecaptchaConfig reCAPTCHA Config를 업데이트하기 위한 요청 인터페이스입니다. reCAPTCHA Enterprise 통합을 사용 설정하면 reCAPTCHA Enterprise 서비스 약관에 동의하는 것으로 간주됩니다.
RecaptchaKey reCAPTCHA 키 구성입니다.
RecaptchaManagedRule reCAPTCHA 작업 규칙의 구성입니다.
SAMLAuthProviderConfig [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) 인증 제공업체 구성 인터페이스입니다. SAML 제공업체는 BaseAuth.createProviderConfig()를 통해 생성할 수 있습니다.
SAMLUpdateAuthProviderRequest SAML 인증 제공업체를 업데이트하기 위한 요청 인터페이스입니다. BaseAuth.updateProviderConfig()를 통해 SAML 제공업체의 구성을 업데이트할 때 사용됩니다.
SessionCookieOptions BaseAuth.createSessionCookie() 메서드에 필요한 세션 쿠키 옵션을 나타내는 인터페이스입니다.
TotpMultiFactorProviderConfig TOTP 2단계 인증의 구성 설정을 나타내는 인터페이스입니다.
UidIdentifier uid로 계정을 조회하는 데 사용됩니다.BaseAuth.getUsers()를 참조하세요.
UpdatePhoneMultiFactorInfoRequest UpdateRequest의 휴대전화별 사용자가 등록한 두 번째 단계를 나타내는 인터페이스입니다.
UpdateProjectConfigRequest 제공된 프로젝트 구성에서 업데이트할 속성을 나타내는 인터페이스입니다.
UpdateRequest 제공된 사용자에 대해 업데이트할 속성을 나타내는 인터페이스입니다.
UpdateTenantRequest 제공된 테넌트에서 업데이트할 속성을 나타내는 인터페이스입니다.
UserImportOptions 클래스의 생성자 BaseAuth.importUsers() 메서드에 필요한 사용자 가져오기 옵션을 나타내는 인터페이스입니다. 비밀번호 해싱 알고리즘 정보를 제공하는 데 사용됩니다.
UserImportRecord BaseAuth.importUsers() 메서드를 통해 Firebase 인증으로 가져올 사용자를 나타내는 인터페이스입니다.
UserImportResult입니다. 사용자를 Firebase 인증으로 일괄 가져오기 위한 BaseAuth.importUsers() 메서드의 응답을 나타내는 인터페이스입니다.
UserMetadataRequest 사용자를 가져올 때 포함할 사용자 메타데이터입니다.
UserProvider Firebase 사용자와 연결할 수 있는 사용자 ID 공급업체를 나타냅니다.
UserProviderRequest 사용자를 가져올 때 포함할 사용자 제공업체 데이터입니다.

유형 별칭

유형 별칭 설명
AuthFactorType 두 번째 요소 유형을 식별합니다.
AuthProviderConfig 인증 제공업체 구성 유형입니다. BaseAuth.createProviderConfig()로 설정합니다.
CreateMultiFactorInfoRequest CreateRequest에 대해 사용자가 등록한 두 번째 단계의 속성을 나타내는 유형입니다.
CreateTenantRequest 새 테넌트에 설정할 속성을 나타내는 인터페이스입니다.
HashAlgorithmType
MultiFactorConfigState 다단계 구성 상태를 식별합니다.
PasswordPolicyEnforcementState 비밀번호 정책의 시행 상태입니다.
RecaptchaAction reCAPTCHA로 보호되는 요청에 대해 취할 작업입니다. - 'BLOCK': reCAPTCHA로 보호되는 요청이 차단됩니다.
RecaptchaKeyClientType입니다. 키의 플랫폼 유형입니다.
RecaptchaProviderEnforcementState reCAPTCHA 보호의 적용 상태입니다. - '사용 안함': 시행되지 않습니다. - 'AUDIT': 평가를 작성하지만 결과를 적용하지 않습니다. - 'ENFORCE': 평가를 작성하고 결과를 적용합니다.
SmsRegionConfig SMS 리전 구성을 업데이트하기 위한 요청 인터페이스입니다. 사용자가 인증 SMS를 보낼 수 있는 리전을 구성합니다. 통화 대상 전화번호의 통화 코드를 기반으로 합니다.
UpdateAuthProviderRequest를 포함합니다.
UpdateMultiFactorInfoRequest UpdateRequest에 대해 사용자가 등록한 두 번째 단계의 속성을 나타내는 유형입니다.
UserIdentifier(사용자 식별자) 조회할 사용자를 식별합니다.

getAuth(앱)

기본 앱 또는 특정 앱의 Auth 서비스를 가져옵니다.

getAuth()는 기본 앱의 Auth 서비스에 액세스하기 위한 인수 없이 호출하거나 getAuth(app)로 호출하여 특정 앱과 연결된 Auth 서비스에 액세스할 수 있습니다.

서명:

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

매개변수

매개변수 유형 설명
앱 앱

반환:

인증

예 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

예 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

인증 요소 유형

두 번째 요소 유형을 식별합니다.

서명:

export type AuthFactorType = 'phone';

AuthProviderConfig

인증 제공업체 구성 유형입니다. BaseAuth.createProviderConfig()로 설정합니다.

서명:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

CreateRequest에 대해 사용자가 등록한 두 번째 단계의 속성을 나타내는 유형입니다.

서명:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

새 테넌트에 설정할 속성을 나타내는 인터페이스입니다.

서명:

export type CreateTenantRequest = UpdateTenantRequest;

해시알고리즘 유형

서명:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

다중 요소 구성 상태

다단계 구성 상태를 식별합니다.

서명:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

PasswordPolicyEnforcementState

비밀번호 정책의 시행 상태입니다.

서명:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAction

reCAPTCHA로 보호되는 요청에 대해 취할 작업입니다. - 'BLOCK': reCAPTCHA로 보호되는 요청이 차단됩니다.

서명:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType 유형

키의 플랫폼 유형입니다.

서명:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

reCAPTCHA 보호의 적용 상태입니다. - '사용 안함': 시행되지 않습니다. - 'AUDIT': 평가를 작성하지만 결과를 적용하지 않습니다. - 'ENFORCE': 평가를 작성하고 결과를 적용합니다.

서명:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

SmsRegionConfig 클래스의 정적 변수

SMS 리전 구성을 업데이트하기 위한 요청 인터페이스입니다. 사용자가 인증 SMS를 보낼 수 있는 리전을 구성합니다. 통화 대상 전화번호의 통화 코드를 기반으로 합니다.

서명:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest 클래스의 생성자

서명:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

UpdateRequest에 사용자가 등록한 두 번째 단계의 속성을 나타내는 유형입니다.

서명:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

사용자 식별자

조회할 사용자를 식별합니다.

서명:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;