firebase-admin.auth package

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

Функции

Классы

Интерфейсы

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

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;