BaseAuth class

AuthTenantAwareAuth API 모두에 대한 공통 상위 인터페이스입니다.

서명:

export declare abstract class BaseAuth 

행동 양식

방법 수정자 설명
createCustomToken(uid, 개발자Claims) 클라이언트 SDK의 signInWithCustomToken() 메서드로 로그인하는 데 사용할 수 있도록 클라이언트 기기로 다시 보낼 수 있는 새로운 Firebase 맞춤 토큰(JWT)을 만듭니다. (테넌트 인식 인스턴스는 토큰에 테넌트 ID도 포함합니다.) 코드 샘플 및 자세한 설명서는 사용자 지정 토큰 만들기를 참조하세요.
createProviderConfig(구성) 새 공급자 구성이 생성될 때 새로 생성된 AuthProviderConfig 로 해결되는 약속을 반환합니다. SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .
createSessionCookie(idToken, sessionCookieOptions) 지정된 옵션을 사용하여 새 Firebase 세션 쿠키를 만듭니다. 생성된 JWT 문자열은 맞춤형 쿠키 정책을 통해 서버측 세션 쿠키로 설정되어 세션 관리에 사용될 수 있습니다. 세션 쿠키 JWT는 제공된 ID 토큰과 동일한 페이로드 청구를 갖습니다. 코드 샘플 및 자세한 문서는 세션 쿠키 관리를 참조하세요.
createUser(속성) 새로운 사용자를 생성합니다. 코드 샘플 및 자세한 설명서는 사용자 만들기를 참조하세요.
deleteProviderConfig(providerId) 전달된 공급자 ID에 해당하는 공급자 구성을 삭제합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다. SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .
삭제사용자(uid) 기존 사용자를 삭제합니다. 코드 샘플 및 자세한 설명서는 사용자 삭제를 참조하세요.
삭제사용자(uid) 지정된 uid로 지정된 사용자를 삭제합니다. 존재하지 않는 사용자를 삭제해도 오류가 생성되지 않습니다(즉, 이 방법은 멱등적입니다.) 존재하지 않는 사용자는 성공적으로 삭제된 것으로 간주되므로 DeleteUsersResult.successCount 값에 계산됩니다. 최대 1000개의 식별자만 제공할 수 있습니다. 1000개가 넘는 식별자가 제공되면 이 메소드에서 FirebaseAuthError가 발생합니다. 이 API는 현재 서버에서 속도가 1QPS로 제한되어 있습니다. 이를 초과하면 할당량 초과 오류가 발생할 수 있습니다. 따라서 1000명이 넘는 사용자를 삭제하려면 이 제한을 초과하지 않도록 지연을 추가해야 할 수도 있습니다.
generateEmailVerificationLink(이메일, actionCodeSettings) 지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.
generatePasswordResetLink(이메일, actionCodeSettings) 사용자 비밀번호를 재설정하기 위한 대역 외 이메일 작업 링크를 생성합니다. 지정된 이메일 주소를 가진 사용자에 대해 링크가 생성됩니다. 선택적 ActionCodeSettings 개체는 링크가 모바일 앱이나 브라우저에 의해 처리되는지 여부와 딥 링크 등에서 전달될 추가 상태 정보를 정의합니다.
generateSignInWithEmailLink(이메일, actionCodeSettings) 지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.
generateVerifyAndChangeEmailLink(이메일, newEmail, actionCodeSettings) 지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.
getProviderConfig(공급자 ID) 제공된 ID로 인증 공급자 구성을 조회합니다. 지정된 공급자 ID에 해당하는 공급자 구성으로 해결되는 약속을 반환합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다. SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .
getUser(UID) 특정 uid 에 해당하는 사용자의 사용자 데이터를 가져옵니다. 코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.
getUserByEmail(이메일) 특정 이메일에 해당하는 사용자의 사용자 데이터를 가져옵니다. 코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.
getUserByPhoneNumber(전화번호) 특정 전화번호에 해당하는 사용자의 사용자 데이터를 가져옵니다. 전화번호는 E.164 사양을 준수해야 합니다. 코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.
getUserByProviderUid(providerId, uid) 특정 공급자 ID에 해당하는 사용자의 사용자 데이터를 가져옵니다. 코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.
getUsers(식별자) 지정된 식별자에 해당하는 사용자 데이터를 가져옵니다. 주문 보장은 없습니다. 특히 결과 목록의 n번째 항목이 입력 매개변수 목록의 n번째 항목과 일치한다고 보장되지는 않습니다. 최대 100개의 식별자만 제공할 수 있습니다. 100개가 넘는 식별자가 제공되면 이 메소드에서 FirebaseAuthError가 발생합니다.
importUsers(사용자, 옵션) 제공된 사용자 목록을 Firebase 인증으로 가져옵니다. 한 번에 한 명씩 가져올 수 있는 사용자는 최대 1000명입니다. 비밀번호를 사용하여 사용자를 가져올 때 UserImportOptions를 지정해야 합니다. 이 작업은 대량 가져오기에 최적화되어 있으며 중복이 발생할 수 있는 uid , email 및 기타 식별자 고유성에 대한 확인을 무시합니다.
listProviderConfigs(옵션) 제공된 필터와 일치하는 기존 공급자 구성 목록을 반환합니다. 한 번에 최대 100개의 공급자 구성을 나열할 수 있습니다. SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .
listUsers(maxResults, pageToken) pageToken 에 지정된 오프셋에서 시작하여 maxResults 크기의 사용자 목록(단일 배치만)을 검색합니다. 특정 프로젝트의 모든 사용자를 일괄적으로 조회하는데 사용됩니다. 코드 샘플 및 자세한 설명서는 모든 사용자 나열을 참조하세요.
revokeRefreshTokens(uid) 기존 사용자에 대한 모든 새로 고침 토큰을 취소합니다. 이 API는 사용자의 UserRecord.tokensValidAfterTime을 현재 UTC로 업데이트합니다. 이것이 호출되는 서버의 시계가 올바르게 설정되고 동기화되는 것이 중요합니다. 이렇게 하면 지정된 사용자에 대한 모든 세션이 취소되고 기존 세션에 대한 새 ID 토큰이 생성되지 않도록 비활성화되지만 기존 ID 토큰은 자연 만료(1시간)까지 활성 상태로 유지될 수 있습니다. ID 토큰이 취소되었는지 확인하려면 checkRevoked true로 설정된 BaseAuth.verifyIdToken()을 사용하세요.
setCustomUserClaims(uid, customUserClaims) 일반적으로 사용자 역할 및 액세스 수준을 정의하는 데 사용되는 제공된 uid 로 식별되는 기존 사용자에 대한 추가 개발자 클레임을 설정합니다. 이러한 클레임은 사용자가 이미 로그인한 모든 장치(토큰 만료 후 또는 토큰 새로 고침이 강제로 실행되는 경우)와 사용자가 다음에 로그인할 때 전파되어야 합니다. 예약된 OIDC 클레임 이름이 사용되는 경우(sub, iat, iss 등) ), 오류가 발생합니다. 인증된 사용자의 ID 토큰 JWT에 설정됩니다. 코드 샘플과 자세한 문서는 사용자 역할 및 액세스 수준 정의를 참조하세요.
updateProviderConfig(providerId, 업데이트된Config) 지정된 공급자 ID에 해당하는 업데이트된 AuthProviderConfig 로 해결되는 약속을 반환합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다. SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .
updateUser(uid, 속성) 기존 사용자를 업데이트합니다. 코드 샘플 및 자세한 설명서는 사용자 업데이트를 참조하세요.
verifyIdToken(idToken, checkRevoked) Firebase ID 토큰(JWT)을 확인합니다. 토큰이 유효하면 토큰의 디코딩된 클레임으로 약속이 이행됩니다. 그렇지 않으면 약속이 거부됩니다. checkRevoked true로 설정된 경우 먼저 해당 사용자의 비활성화 여부를 확인합니다. 그렇다면 auth/user-disabled 오류가 발생합니다. 아니요인 경우 ID 토큰에 해당하는 세션이 취소되었는지 확인합니다. 해당 사용자의 세션이 무효화되면 auth/id-token-revoked 오류가 발생합니다. 지정하지 않으면 검사가 적용되지 않습니다. 코드 샘플 및 자세한 문서는 ID 토큰 확인을 참조하세요.
verifySessionCookie(sessionCookie, checkRevoked) Firebase 세션 쿠키를 확인합니다. 쿠키 클레임과 함께 Promise를 반환합니다. 쿠키를 확인할 수 없으면 약속을 거부합니다. checkRevoked true로 설정된 경우 해당 사용자가 비활성화되어 있는지 먼저 확인합니다. 그렇다면 auth/user-disabled 오류가 발생합니다. 아니요인 경우 세션 쿠키에 해당하는 세션이 취소되었는지 확인합니다. 해당 사용자의 세션이 무효화되면 auth/session-cookie-revoked 오류가 발생합니다. 지정하지 않으면 검사가 수행되지 않습니다. 코드 샘플 및 자세한 문서는 세션 쿠키 확인을 참조하세요.

BaseAuth.createCustomToken()

클라이언트 SDK의 signInWithCustomToken() 메서드로 로그인하는 데 사용할 수 있도록 클라이언트 기기로 다시 보낼 수 있는 새로운 Firebase 맞춤 토큰(JWT)을 만듭니다. (테넌트 인식 인스턴스는 토큰에 테넌트 ID도 포함합니다.)

코드 샘플 및 자세한 설명서는 사용자 지정 토큰 만들기를 참조하세요.

서명:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

매개변수

매개변수 유형 설명
UID 사용자 정의 토큰의 제목으로 사용할 uid .
개발자클레임 물체 사용자 지정 토큰의 페이로드에 포함할 선택적 추가 클레임입니다.

보고:

약속<문자열>

제공된 uid 및 페이로드에 대한 사용자 정의 토큰으로 이행되는 약속입니다.

BaseAuth.createProviderConfig()

새 공급자 구성이 생성될 때 새로 생성된 AuthProviderConfig 로 해결되는 약속을 반환합니다.

SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .

서명:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

매개변수

매개변수 유형 설명
구성 인증 제공자 구성 생성할 공급자 구성입니다.

보고:

약속< AuthProviderConfig >

생성된 공급자 구성으로 해결되는 Promise입니다.

BaseAuth.createSessionCookie()

지정된 옵션을 사용하여 새 Firebase 세션 쿠키를 만듭니다. 생성된 JWT 문자열은 맞춤형 쿠키 정책을 통해 서버측 세션 쿠키로 설정되어 세션 관리에 사용될 수 있습니다. 세션 쿠키 JWT는 제공된 ID 토큰과 동일한 페이로드 청구를 갖습니다.

코드 샘플 및 자세한 문서는 세션 쿠키 관리를 참조하세요.

서명:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

매개변수

매개변수 유형 설명
아이디토큰 세션 쿠키로 교환할 Firebase ID 토큰입니다.
세션쿠키옵션 세션쿠키옵션 사용자 정의 세션 기간을 포함하는 세션 쿠키 옵션입니다.

보고:

약속<문자열>

생성된 세션 쿠키의 성공 시 해결되는 약속입니다.

BaseAuth.createUser()

새로운 사용자를 생성합니다.

코드 샘플 및 자세한 설명서는 사용자 만들기를 참조하세요.

서명:

createUser(properties: CreateRequest): Promise<UserRecord>;

매개변수

매개변수 유형 설명
속성 요청 생성 생성될 새 사용자 레코드에 설정할 속성입니다.

보고:

약속< 사용자 기록 >

새로 생성된 사용자에 해당하는 사용자 데이터로 이행되는 약속입니다.

BaseAuth.deleteProviderConfig()

전달된 공급자 ID에 해당하는 공급자 구성을 삭제합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다.

SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .

서명:

deleteProviderConfig(providerId: string): Promise<void>;

매개변수

매개변수 유형 설명
공급자 ID 삭제할 공급자 구성에 해당하는 공급자 ID입니다.

보고:

약속<공허>

완료 시 해결되는 약속입니다.

BaseAuth.deleteUser()

기존 사용자를 삭제합니다.

코드 샘플 및 자세한 설명서는 사용자 삭제를 참조하세요.

서명:

deleteUser(uid: string): Promise<void>;

매개변수

매개변수 유형 설명
UID 삭제할 사용자에 해당하는 uid .

보고:

약속<공허>

사용자가 삭제되면 빈 약속이 이행됩니다.

BaseAuth.deleteUsers()

지정된 uid로 지정된 사용자를 삭제합니다.

존재하지 않는 사용자를 삭제해도 오류가 생성되지 않습니다(즉, 이 방법은 멱등적입니다.) 존재하지 않는 사용자는 성공적으로 삭제된 것으로 간주되므로 DeleteUsersResult.successCount 값에 계산됩니다.

최대 1000개의 식별자만 제공할 수 있습니다. 1000개가 넘는 식별자가 제공되면 이 메소드에서 FirebaseAuthError가 발생합니다.

이 API는 현재 서버에서 속도가 1QPS로 제한되어 있습니다. 이를 초과하면 할당량 초과 오류가 발생할 수 있습니다. 따라서 1000명이 넘는 사용자를 삭제하려면 이 제한을 초과하지 않도록 지연을 추가해야 할 수도 있습니다.

서명:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

매개변수

매개변수 유형 설명
UI즈 끈[] 삭제할 사용자에 해당하는 uids .

보고:

약속< DeleteUsersResult >

총 성공/실패한 삭제 수와 실패한 삭제에 해당하는 오류 배열을 확인하는 Promise입니다.

지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.

서명:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

매개변수

매개변수 유형 설명
이메일 확인할 이메일 계정입니다.
액션코드설정 액션코드설정 조치 코드 설정입니다. 지정된 경우 상태/계속 URL은 이메일 확인 링크의 "continueUrl" 매개변수로 설정됩니다. 기본 이메일 확인 랜딩 페이지는 이를 사용하여 설치된 앱으로 돌아갈 수 있는 링크를 표시합니다. actionCodeSettings를 지정하지 않으면 작업 URL에 URL이 추가되지 않습니다. 제공된 상태 URL은 개발자가 콘솔에서 허용 목록에 추가한 도메인에 속해야 합니다. 그렇지 않으면 오류가 발생합니다. 모바일 앱 리디렉션은 개발자가 Firebase 동적 링크 서비스 약관을 구성하고 동의한 경우에만 적용 가능합니다. Android 패키지 이름과 iOS 번들 ID는 동일한 Firebase 인증 프로젝트에 구성된 경우에만 적용됩니다.

보고:

약속<문자열>

생성된 링크로 해결되는 Promise입니다.

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

사용자 비밀번호를 재설정하기 위한 대역 외 이메일 작업 링크를 생성합니다. 지정된 이메일 주소를 가진 사용자에 대해 링크가 생성됩니다. 선택적 ActionCodeSettings 개체는 링크가 모바일 앱이나 브라우저에 의해 처리되는지 여부와 딥 링크 등에서 전달될 추가 상태 정보를 정의합니다.

서명:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

매개변수

매개변수 유형 설명
이메일 비밀번호를 재설정할 사용자의 이메일 주소입니다.
액션코드설정 액션코드설정 조치 코드 설정입니다. 지정된 경우 상태/계속 URL은 비밀번호 재설정 링크의 "continueUrl" 매개변수로 설정됩니다. 기본 비밀번호 재설정 랜딩 페이지는 이를 사용하여 설치된 앱으로 돌아갈 수 있는 링크를 표시합니다. actionCodeSettings를 지정하지 않으면 작업 URL에 URL이 추가되지 않습니다. 제공된 상태 URL은 개발자가 콘솔에서 허용 목록에 추가한 도메인에 속해야 합니다. 그렇지 않으면 오류가 발생합니다. 모바일 앱 리디렉션은 개발자가 Firebase 동적 링크 서비스 약관을 구성하고 동의한 경우에만 적용 가능합니다. Android 패키지 이름과 iOS 번들 ID는 동일한 Firebase 인증 프로젝트에 구성된 경우에만 존중됩니다.

보고:

약속<문자열>

생성된 링크로 해결되는 Promise입니다.

var 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,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.

서명:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

매개변수

매개변수 유형 설명
이메일 확인할 이메일 계정입니다.
액션코드설정 액션코드설정 조치 코드 설정입니다. 지정된 경우 상태/계속 URL은 이메일 확인 링크의 "continueUrl" 매개변수로 설정됩니다. 기본 이메일 확인 랜딩 페이지는 이를 사용하여 설치된 앱으로 돌아갈 수 있는 링크를 표시합니다. actionCodeSettings를 지정하지 않으면 작업 URL에 URL이 추가되지 않습니다. 제공된 상태 URL은 개발자가 콘솔에서 허용 목록에 추가한 도메인에 속해야 합니다. 그렇지 않으면 오류가 발생합니다. 모바일 앱 리디렉션은 개발자가 Firebase 동적 링크 서비스 약관을 구성하고 동의한 경우에만 적용 가능합니다. Android 패키지 이름과 iOS 번들 ID는 동일한 Firebase 인증 프로젝트에 구성된 경우에만 존중됩니다.

보고:

약속<문자열>

생성된 링크로 해결되는 Promise입니다.

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

지정된 이메일에 대한 사용자 소유권을 확인하기 위해 대역 외 이메일 작업 링크를 생성합니다. 이 메소드의 인수로 제공되는 ActionCodeSettings 객체는 딥 링크 등에서 전달할 추가 상태 정보와 함께 링크를 모바일 앱에서 처리할지 브라우저에서 처리할지 여부를 정의합니다.

서명:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

매개변수

매개변수 유형 설명
이메일 현재 이메일 계정입니다.
새로운이메일 계정이 업데이트되는 이메일 주소입니다.
액션코드설정 액션코드설정 조치 코드 설정입니다. 지정된 경우 상태/계속 URL은 이메일 확인 링크의 "continueUrl" 매개변수로 설정됩니다. 기본 이메일 확인 랜딩 페이지는 이를 사용하여 설치된 앱으로 돌아갈 수 있는 링크를 표시합니다. actionCodeSettings를 지정하지 않으면 작업 URL에 URL이 추가되지 않습니다. 제공된 상태 URL은 콘솔에서 승인된 도메인에 속해야 합니다. 그렇지 않으면 오류가 발생합니다. 모바일 앱 리디렉션은 개발자가 Firebase 동적 링크 서비스 약관을 구성하고 동의한 경우에만 적용 가능합니다. Android 패키지 이름과 iOS 번들 ID는 동일한 Firebase 인증 프로젝트에 구성된 경우에만 존중됩니다.

보고:

약속<문자열>

생성된 링크로 해결되는 Promise입니다.

BaseAuth.getProviderConfig()

제공된 ID로 인증 공급자 구성을 조회합니다. 지정된 공급자 ID에 해당하는 공급자 구성으로 해결되는 약속을 반환합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다.

SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .

서명:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

매개변수

매개변수 유형 설명
공급자 ID 반환할 공급자 구성에 해당하는 공급자 ID입니다.

보고:

약속< AuthProviderConfig >

제공된 ID에 해당하는 구성으로 해결되는 Promise입니다.

BaseAuth.getUser()

특정 uid 에 해당하는 사용자의 사용자 데이터를 가져옵니다. .

코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.

서명:

getUser(uid: string): Promise<UserRecord>;

매개변수

매개변수 유형 설명
UID 가져올 데이터가 있는 사용자에 해당하는 uid .

보고:

약속< 사용자 기록 >

제공된 uid 에 해당하는 사용자 데이터로 이행되는 약속 .

BaseAuth.getUserByEmail()

특정 이메일에 해당하는 사용자의 사용자 데이터를 가져옵니다.

코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.

서명:

getUserByEmail(email: string): Promise<UserRecord>;

매개변수

매개변수 유형 설명
이메일 데이터를 가져올 사용자에 해당하는 이메일입니다.

보고:

약속< 사용자 기록 >

제공된 이메일에 해당하는 사용자 데이터로 이행되는 약속입니다.

BaseAuth.getUserByPhoneNumber()

특정 전화번호에 해당하는 사용자의 사용자 데이터를 가져옵니다. 전화번호는 E.164 사양을 준수해야 합니다.

코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.

서명:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

매개변수

매개변수 유형 설명
전화 번호 데이터를 가져올 사용자에 해당하는 전화번호입니다.

보고:

약속< 사용자 기록 >

제공된 전화번호에 해당하는 사용자 데이터로 이행되는 약속입니다.

BaseAuth.getUserByProviderUid()

특정 공급자 ID에 해당하는 사용자의 사용자 데이터를 가져옵니다.

코드 샘플 및 자세한 문서는 사용자 데이터 검색을 참조하세요.

서명:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

매개변수

매개변수 유형 설명
공급자 ID 공급자 ID입니다(예: Google 공급자의 경우 'google.com').
UID 해당 제공업체의 사용자 식별자입니다.

보고:

약속< 사용자 기록 >

주어진 공급자 ID에 해당하는 사용자 데이터로 이행되는 약속입니다.

BaseAuth.getUsers()

지정된 식별자에 해당하는 사용자 데이터를 가져옵니다.

주문 보장은 없습니다. 특히 결과 목록의 n번째 항목이 입력 매개변수 목록의 n번째 항목과 일치한다고 보장되지는 않습니다.

최대 100개의 식별자만 제공할 수 있습니다. 100개가 넘는 식별자가 제공되면 이 메소드에서 FirebaseAuthError가 발생합니다.

서명:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

매개변수

매개변수 유형 설명
식별자 사용자 식별자 [] 반환해야 하는 사용자 레코드를 나타내는 데 사용되는 식별자입니다. 항목이 100개를 초과할 수 없습니다.

보고:

약속< GetUsersResult >

해당 사용자 레코드로 해결되는 Promise입니다.

예외

FirebaseAuthError 식별자 중 하나라도 유효하지 않거나 100개 이상의 식별자가 지정된 경우입니다.

BaseAuth.importUsers()

제공된 사용자 목록을 Firebase 인증으로 가져옵니다. 한 번에 한 명씩 가져올 수 있는 사용자는 최대 1000명입니다. 비밀번호를 사용하여 사용자를 가져올 때 UserImportOptions를 지정해야 합니다. 이 작업은 대량 가져오기에 최적화되어 있으며 uid 확인을 무시합니다. , email 및 기타 식별자 고유성으로 인해 중복이 발생할 수 있습니다.

서명:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

매개변수

매개변수 유형 설명
사용자 사용자가져오기기록 [] Firebase 인증으로 가져올 사용자 레코드 목록입니다.
옵션 사용자가져오기옵션 제공된 사용자가 비밀번호 자격 증명을 포함하는 경우 필요한 사용자 가져오기 옵션입니다.

보고:

약속< UserImportResult >

가져오기 결과로 작업이 완료될 때 해결되는 약속입니다. 여기에는 성공한 가져오기 수, 실패한 가져오기 수 및 해당 오류가 포함됩니다.

BaseAuth.listProviderConfigs()

제공된 필터와 일치하는 기존 공급자 구성 목록을 반환합니다. 한 번에 최대 100개의 공급자 구성을 나열할 수 있습니다.

SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .

서명:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

매개변수

매개변수 유형 설명
옵션 인증 제공자 구성 필터 적용할 공급자 구성 필터입니다.

보고:

약속< ListProviderConfigResults >

필터 요구 사항을 충족하는 공급자 구성 목록으로 해결되는 약속입니다.

BaseAuth.listUsers()

pageToken 에 지정된 오프셋에서 시작하여 maxResults 크기의 사용자 목록(단일 배치만)을 검색합니다. . 특정 프로젝트의 모든 사용자를 일괄적으로 조회하는데 사용됩니다.

코드 샘플 및 자세한 설명서는 모든 사용자 나열을 참조하세요.

서명:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

매개변수

매개변수 유형 설명
최대 결과 숫자 페이지 크기는 정의되지 않은 경우 1000입니다. 이는 최대 허용 한도이기도 합니다.
페이지토큰 다음 페이지 토큰입니다. 지정하지 않으면 오프셋 없이 시작하는 사용자를 반환합니다.

보고:

약속< ListUsersResult >

다운로드된 사용자의 현재 배치와 다음 페이지 토큰으로 해결되는 약속입니다.

BaseAuth.revokeRefreshTokens()

기존 사용자에 대한 모든 새로 고침 토큰을 취소합니다.

이 API는 사용자의 UserRecord.tokensValidAfterTime을 현재 UTC로 업데이트합니다. 이것이 호출되는 서버의 시계가 올바르게 설정되고 동기화되는 것이 중요합니다.

이렇게 하면 지정된 사용자에 대한 모든 세션이 취소되고 기존 세션에 대한 새 ID 토큰이 생성되지 않도록 비활성화되지만 기존 ID 토큰은 자연 만료(1시간)까지 활성 상태로 유지될 수 있습니다. ID 토큰이 취소되었는지 확인하려면 checkRevoked true로 설정된 BaseAuth.verifyIdToken()을 사용하세요.

서명:

revokeRefreshTokens(uid: string): Promise<void>;

매개변수

매개변수 유형 설명
UID 새로 고침 토큰을 취소할 사용자에 해당하는 uid .

보고:

약속<공허>

사용자의 새로 고침 토큰이 취소되면 빈 약속이 이행됩니다.

BaseAuth.setCustomUserClaims()

제공된 uid 로 식별된 기존 사용자에 대한 추가 개발자 클레임을 설정합니다. , 일반적으로 사용자 역할 및 액세스 수준을 정의하는 데 사용됩니다. 이러한 클레임은 사용자가 이미 로그인한 모든 장치(토큰 만료 후 또는 토큰 새로 고침이 강제로 실행되는 경우)와 사용자가 다음에 로그인할 때 전파되어야 합니다. 예약된 OIDC 클레임 이름이 사용되는 경우(sub, iat, iss 등) ), 오류가 발생합니다. 인증된 사용자의 ID 토큰 JWT에 설정됩니다.

코드 샘플과 자세한 문서는 사용자 역할 및 액세스 수준 정의를 참조하세요.

서명:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

매개변수

매개변수 유형 설명
UID 편집할 사용자의 uid .
맞춤사용자클레임 개체 | 없는 개발자는 설정을 주장합니다. null이 전달되면 기존 사용자 지정 클레임이 삭제됩니다. 1000바이트보다 큰 사용자 지정 클레임 페이로드를 전달하면 오류가 발생합니다. 사용자 정의 클레임은 인증된 모든 요청에 ​​대해 전송되는 사용자 ID 토큰에 추가됩니다. 프로필 비접속 관련 사용자 속성은 데이터베이스나 기타 별도의 저장 시스템을 사용하세요.

보고:

약속<공허>

작업이 성공적으로 완료되면 해결되는 약속입니다.

BaseAuth.updateProviderConfig()

지정된 공급자 ID에 해당하는 업데이트된 AuthProviderConfig 로 해결되는 약속을 반환합니다. 지정된 ID가 존재하지 않으면 auth/configuration-not-found 오류가 발생합니다.

SAML 및 OIDC 제공업체를 지원하려면 Google Cloud의 Identity Platform(GCIP)이 필요합니다. 가격 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요. .

서명:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

매개변수

매개변수 유형 설명
공급자 ID 업데이트할 공급자 구성에 해당하는 공급자 ID입니다.
업데이트된 구성 업데이트인증 제공자 요청 업데이트된 구성.

보고:

약속< AuthProviderConfig >

업데이트된 공급자 구성으로 해결되는 약속입니다.

BaseAuth.updateUser()

기존 사용자를 업데이트합니다.

코드 샘플 및 자세한 설명서는 사용자 업데이트를 참조하세요.

서명:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

매개변수

매개변수 유형 설명
UID 업데이트할 사용자에 해당하는 uid .
속성 업데이트요청 제공된 사용자에 대해 업데이트할 속성입니다.

보고:

약속< 사용자 기록 >

업데이트된 사용자 데이터로 이행되는 약속입니다.

BaseAuth.verifyIdToken()

Firebase ID 토큰(JWT)을 확인합니다. 토큰이 유효하면 토큰의 디코딩된 클레임으로 약속이 이행됩니다. 그렇지 않으면 약속이 거부됩니다.

checkRevoked true로 설정된 경우 먼저 해당 사용자의 비활성화 여부를 확인합니다. 그렇다면 auth/user-disabled 오류가 발생합니다. 아니요인 경우 ID 토큰에 해당하는 세션이 취소되었는지 확인합니다. 해당 사용자의 세션이 무효화되면 auth/id-token-revoked 오류가 발생합니다. 지정하지 않으면 검사가 적용되지 않습니다.

코드 샘플 및 자세한 문서는 ID 토큰 확인을 참조하세요.

서명:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

매개변수

매개변수 유형 설명
아이디토큰 확인할 ID 토큰입니다.
수표가 취소됨 부울 ID 토큰이 취소되었는지 확인할지 여부입니다. 이를 위해서는 해당 사용자의 tokensValidAfterTime 시간을 확인하기 위해 Firebase 인증 백엔드에 대한 추가 요청이 필요합니다. 지정하지 않으면 이 추가 검사가 적용되지 않습니다.

보고:

약속< DecodedIdToken >

ID 토큰이 유효한 경우 토큰의 디코딩된 클레임으로 이행되는 약속입니다. 그렇지 않으면 거부된 약속입니다.

BaseAuth.verifySessionCookie()

Firebase 세션 쿠키를 확인합니다. 쿠키 클레임과 함께 Promise를 반환합니다. 쿠키를 확인할 수 없으면 약속을 거부합니다.

checkRevoked true로 설정된 경우 해당 사용자가 비활성화되어 있는지 먼저 확인합니다. 그렇다면 auth/user-disabled 오류가 발생합니다. 아니요인 경우 세션 쿠키에 해당하는 세션이 취소되었는지 확인합니다. 해당 사용자의 세션이 무효화되면 auth/session-cookie-revoked 오류가 발생합니다. 지정하지 않으면 검사가 수행되지 않습니다.

코드 샘플 및 자세한 문서는 세션 쿠키 확인을 참조하세요.

서명:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

매개변수

매개변수 유형 설명
세션쿠키 확인할 세션 쿠키입니다.
수표가 취소됨 부울

보고:

약속< DecodedIdToken >

세션 쿠키가 유효한 경우 세션 쿠키의 디코딩된 클레임으로 이행되는 약속입니다. 그렇지 않으면 거부된 약속입니다.