firebase-admin.auth package

Аутентификация Firebase.

Функции

Функция Описание
getAuth (приложение) Получает службу проверки подлинности для приложения по умолчанию или заданного приложения. getAuth() можно вызвать без аргументов для доступа к службе аутентификации приложения по умолчанию или как getAuth(app) для доступа к службе аутентификации , связанной с конкретным приложением.

Классы

Сорт Описание
Авторизация Служба аутентификации, привязанная к предоставленному приложению. Экземпляр Auth может иметь несколько клиентов.
Аутклиентерроркоде Коды ошибок клиента аутентификации и их сообщения по умолчанию.
Базовая аутентификация Общий родительский интерфейс для API Auth и TenantAwareAuth .
FirebaseAuthError Структура кода ошибки аутентификации Firebase. Это расширяет PrefixedFirebaseError.
Мультифакторинфо Интерфейс, представляющий общие свойства второго фактора, зарегистрированного пользователем.
Многофакторные настройки Многофакторные пользовательские настройки.
ТелефонMultiFactorИнформация Интерфейс, представляющий второй фактор, зарегистрированный пользователем конкретного телефона.
Конфигурация проекта Представляет конфигурацию проекта.
Диспетчер конфигураций проектов Управляет (получает и обновляет) текущую конфигурацию проекта.
Жилец Представляет конфигурацию клиента. Для поддержки мультитенантности требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . Прежде чем использовать мультитенантность в проекте Google Cloud Identity Platform, арендаторам необходимо разрешить участие в этом проекте через пользовательский интерфейс Cloud Console. Конфигурация клиента предоставляет такую ​​информацию, как отображаемое имя, идентификатор клиента и конфигурация аутентификации электронной почты. Для управления конфигурацией поставщика OIDC/SAML вместо Tenant следует использовать экземпляры TenantAwareAuth для получения списка настроенных IdP в арендаторе. При настройке этих поставщиков обратите внимание, что клиенты будут наследовать домены из белого списка и URI перенаправления с проверкой подлинности своего родительского проекта. Все остальные настройки арендатора также будут унаследованы. Им необходимо будет управлять из пользовательского интерфейса Cloud Console.
TenantAwareAuth Интерфейс Auth с учетом арендаторов, используемый для управления пользователями, настройки поставщиков SAML/OIDC, создания ссылок электронной почты для сброса пароля, проверки электронной почты и т. д. для конкретных арендаторов. Для поддержки мультитенантности требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . Каждый арендатор содержит собственных поставщиков удостоверений, настройки и наборы пользователей. С помощью TenantAwareAuth также можно управлять пользователями конкретного арендатора и соответствующими конфигурациями OIDC/SAML, проверять токены идентификаторов для пользователей, вошедших в определенный арендатор, а также создавать ссылки действий по электронной почте для пользователей, принадлежащих этому арендатору. Экземпляры TenantAwareAuth для определенного tenantId можно создать, вызвав TenantManager.authForTenant(). .
Менеджер арендаторов Определяет менеджера арендатора, используемого для управления операциями, связанными с арендатором. Это включает в себя:
  • Возможность создавать, обновлять, составлять список, получать и удалять арендаторов для базового проекта.
  • Получение экземпляра TenantAwareAuth для выполнения операций, связанных с аутентификацией (управление пользователями, управление конфигурацией поставщика, проверка токена, создание ссылок электронной почты и т. д.) в контексте указанного клиента.
Информация о пользователе Представляет информацию пользователя от стороннего поставщика удостоверений, такого как Google или Facebook.
Пользовательские метаданные Представляет метаданные пользователя.
Пользовательская запись Представляет пользователя.

Интерфейсы

Интерфейс Описание
Параметры кода действия Это интерфейс, который определяет требуемый URL-адрес продолжения/состояния с дополнительными идентификаторами пакетов Android и iOS.
Разрешитьбидефолт Определяет политику разрешения каждого региона по умолчанию и добавления запрещенных регионов в список запрещенных.
Алловбидефаултаурап Взаимно-исключающая конфигурация SMS-региона интерфейса AllowByDefault
Разрешить только Определяет политику разрешения регионов только путем явного добавления их в белый список.
AllowlistOnlyWrap Взаимоисключающая конфигурация SMS-региона интерфейса AllowlistOnly
Аутпровидерконфигфилтер Интерфейс фильтра, используемый для вывода списка конфигураций поставщика. Это используется при указании способа отображения настроенных поставщиков удостоверений с помощью BaseAuth.listProviderConfigs(). .
Базеауспровидерконфиг Интерфейс конфигурации базового поставщика аутентификации.
БазеCreateMultiFactorInfoRequest Интерфейс, представляющий базовые свойства зарегистрированного пользователем второго фактора для CreateRequest .
Базеупдатемультифакторинфореквест Интерфейс, представляющий общие свойства зарегистрированного пользователем второго фактора для UpdateRequest .
CreatePhoneMultiFactorInfoRequest Интерфейс, представляющий второй фактор, зарегистрированный пользователем конкретного телефона, для CreateRequest .
Создать запрос Интерфейс, представляющий свойства, которые необходимо установить для новой создаваемой записи пользователя.
CustomStrengthOptionsConfig Ограничения, которые необходимо соблюдать в политике паролей
ДекодированныйAuthBlockingToken
Декодедидтокен Интерфейс, представляющий декодированный токен идентификатора Firebase, возвращаемый методом BaseAuth.verifyIdToken() . Токены Firebase ID — это веб-токены JSON (JWT), соответствующие спецификации OpenID Connect. Дополнительные сведения о конкретных свойствах см. в разделе [ID Token спецификации OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken).
УдалитьПользователиРезультат Представляет результат BaseAuth.deleteUsers(). . API.
Идентификатор электронной почты Используется для поиска учетной записи по электронной почте. См. BaseAuth.getUsers(). .
Конфигурация конфиденциальности электронной почты Конфигурация конфиденциальности электронной почты проекта или клиента.
EmailSignInProviderConfig Вход по электронной почте в конфигурацию провайдера.
GetUsersResult Представляет результат API BaseAuth.getUsers() .
Листпровидерконфигрезультат Интерфейс ответа для вывода списка конфигураций поставщика. Это доступно только при перечислении всех конфигураций поставщиков удостоверений через BaseAuth.listProviderConfigs(). .
ListTenantsResult Интерфейс, представляющий объект, возвращенный из операции TenantManager.listTenants() . Содержит список клиентов для текущего пакета и токен следующей страницы, если он доступен.
Список пользователейРезультат Интерфейс, представляющий объект, возвращенный из операции BaseAuth.listUsers() . Содержит список пользователей текущего пакета и токен следующей страницы, если он доступен.
Многофакторная конфигурация Интерфейс, представляющий многофакторную конфигурацию. Это можно использовать для определения того, включена или отключена многофакторная аутентификация, а также список поддерживаемых проверок второго фактора.
MultiFactorCreateSettings Многофакторные пользовательские настройки для операций создания.
Мультифакторпровидерконфиг Интерфейс, представляющий конфигурацию поставщика многофакторной аутентификации. Этот интерфейс используется для поставщиков аутентификации второго фактора, отличных от SMS. В настоящее время поддерживается только TOTP.
Параметры мультифакторобнопдате Многофакторные пользовательские настройки для операций обновления.
Тип ответа OAuthResponseType Интерфейс, представляющий объект ответа поставщика OIDC для потока авторизации OAuth. Требуется одна из следующих настроек:
  • Установите code значение true для потока кода.
  • Установите idToken значение true для потока токенов идентификатора.
OIDCAuthProviderConfig Интерфейс конфигурации поставщика аутентификации [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Поставщик OIDC можно создать с помощью BaseAuth.createProviderConfig(). .
ОИДкупдатеауспровидеррекуест Интерфейс запроса для обновления поставщика аутентификации OIDC. Это используется при обновлении конфигурации поставщика OIDC через BaseAuth.updateProviderConfig(). .
Конфигурация политики паролей Конфигурация политики паролей для проекта или клиента
Идентификатор телефона Используется для поиска аккаунта по номеру телефона. См. BaseAuth.getUsers(). .
идентификатор поставщика Используется для поиска учетной записи федеративного провайдера. См. BaseAuth.getUsers(). .
РекапчаКонфигурация Интерфейс запроса для обновления конфигурации reCAPTCHA. Включая интеграцию reCAPTCHA Enterprise, вы соглашаетесь с Условиями обслуживания reCAPTCHA Enterprise. .
РекапчаКлюч Конфигурация ключа reCAPTCHA.
РекапчаУправляемоеПравило Конфигурация правила действия reCAPTCHA.
SAMLAuthProviderConfig Интерфейс конфигурации поставщика аутентификации [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). Поставщик SAML можно создать с помощью BaseAuth.createProviderConfig(). .
SAMLUpdateAuthProviderRequest Интерфейс запроса для обновления поставщика аутентификации SAML. Это используется при обновлении конфигурации поставщика SAML через BaseAuth.updateProviderConfig(). .
Сеанскукиопционс Интерфейс, представляющий параметры cookie сеанса, необходимые для метода BaseAuth.createSessionCookie() .
ТотпМультифакторпровидерконфиг Интерфейс, представляющий настройки конфигурации для аутентификации второго фактора TOTP.
UidИдентификатор Используется для поиска учетной записи по uid. См. BaseAuth.getUsers(). .
ОбновлениеPhoneMultiFactorInfoRequest Интерфейс, представляющий второй фактор, зарегистрированный пользователем конкретного телефона для UpdateRequest .
Обновлениепроектконфигрекуест Интерфейс, представляющий свойства, которые необходимо обновить в предоставленной конфигурации проекта.
Запрос обновления Интерфейс, представляющий свойства, которые необходимо обновить для предоставленного пользователя.
Обновить запрос арендатора Интерфейс, представляющий свойства, которые необходимо обновить в предоставленном клиенте.
Параметры импорта пользователя Интерфейс, представляющий параметры импорта пользователей, необходимые для метода BaseAuth.importUsers() . Это используется для предоставления информации об алгоритме хеширования пароля.
Усеримпортрекорд Интерфейс, представляющий пользователя для импорта в Firebase Auth с помощью метода BaseAuth.importUsers() .
Усеримпортрезультат Интерфейс, представляющий ответ метода BaseAuth.importUsers() для пакетного импорта пользователей в Firebase Auth.
Пользовательский запрос метаданных Метаданные пользователя, которые необходимо включить при импорте пользователя.
Пользовательский поставщик Представляет поставщика удостоверений пользователя, который может быть связан с пользователем Firebase.
Усерпровидеррекуест Данные поставщика пользователей, которые необходимо включить при импорте пользователя.

Введите псевдонимы

Введите псевдоним Описание
Аутфактортипе Определяет второй тип фактора.
Аутпровидерконфиг Тип конфигурации поставщика аутентификации. BaseAuth.createProviderConfig() .
СоздатьMultiFactorInfoRequest Тип, представляющий свойства зарегистрированного пользователем второго фактора для CreateRequest .
Создание запроса арендатора Интерфейс, представляющий свойства, которые необходимо установить для нового клиента.
Тип хеш-алгоритма
Мультифакторконфигстате Идентифицирует состояние многофакторной конфигурации.
ПарольПолициенфорсментстате Состояние применения политики паролей.
RecaptchaДействие Действия, которые необходимо предпринять для запросов, защищенных reCAPTCHA. - «БЛОКИРОВАТЬ»: запрос, защищенный reCAPTCHA, будет заблокирован.
РекапчаКейКлиентТип Тип платформы ключа.
Рекапчапровидерэнфорсментстате Состояние принудительного применения защиты reCAPTCHA. - «ВЫКЛ»: не применяется. - «АУДИТ»: создайте оценку, но не обеспечьте соблюдение результатов. - «СОБЛЮДЕНИЕ»: создать оценку и обеспечить соблюдение результатов.
СмсРегионКонфиг Интерфейс запроса для обновления конфигурации региона SMS. Настраивает регионы, в которых пользователям разрешено отправлять проверочные SMS. Это основано на коде вызова телефонного номера пункта назначения.
ОбновлениеAuthProviderRequest
ОбновлениеMultiFactorInfoRequest Тип, представляющий свойства зарегистрированного пользователем второго фактора для UpdateRequest .
Идентификатор пользователя Идентифицирует пользователя, которого нужно найти.

getAuth (приложение)

Получает службу проверки подлинности для приложения по умолчанию или заданного приложения.

getAuth() можно вызвать без аргументов для доступа к службе аутентификации приложения по умолчанию или как getAuth(app) для доступа к службе аутентификации , связанной с конкретным приложением.

Подпись:

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';

Аутпровидерконфиг

Тип конфигурации поставщика аутентификации. BaseAuth.createProviderConfig() .

Подпись:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

СоздатьMultiFactorInfoRequest

Тип, представляющий свойства зарегистрированного пользователем второго фактора для CreateRequest .

Подпись:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

Создание запроса арендатора

Интерфейс, представляющий свойства, которые необходимо установить для нового клиента.

Подпись:

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';

ПарольПолициенфорсментстате

Состояние применения политики паролей.

Подпись: 

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

RecaptchaДействие

Действия, которые необходимо предпринять для запросов, защищенных reCAPTCHA. - «БЛОКИРОВАТЬ»: запрос, защищенный reCAPTCHA, будет заблокирован.

Подпись: 

export type RecaptchaAction = 'BLOCK';

РекапчаКейКлиентТип

Тип платформы ключа.

Подпись: 

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

Рекапчапровидерэнфорсментстате

Состояние принудительного применения защиты reCAPTCHA. - «ВЫКЛ»: не применяется. - «АУДИТ»: создайте оценку, но не обеспечьте соблюдение результатов. - «СОБЛЮДЕНИЕ»: создать оценку и обеспечить соблюдение результатов.

Подпись: 

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

СмсРегионКонфиг

Интерфейс запроса для обновления конфигурации региона SMS. Настраивает регионы, в которых пользователям разрешено отправлять проверочные SMS. Это основано на коде вызова телефонного номера пункта назначения.

Подпись: 

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

ОбновлениеAuthProviderRequest

Подпись: 

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

ОбновлениеMultiFactorInfoRequest

Тип, представляющий свойства зарегистрированного пользователем второго фактора для UpdateRequest .

Подпись: 

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Идентификатор пользователя

Идентифицирует пользователя, которого нужно найти.

Подпись: 

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