BaseAuth class

Общий родительский интерфейс для API Auth и TenantAwareAuth .

Подпись:

export declare abstract class BaseAuth 

Методы

BaseAuth.createCustomToken()

Создает новый пользовательский токен Firebase (JWT), который можно отправить обратно на клиентское устройство и использовать для входа в систему с помощью методов signInWithCustomToken() клиентских SDK. (Экземпляры с поддержкой клиента также будут встраивать идентификатор клиента в токен.)

Примеры кода и подробную документацию см. в разделе Создание пользовательских токенов.

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, выполненное с помощью специального токена для предоставленного uid и полезных данных.

BaseAuth.createProviderConfig()

Возвращает обещание, которое разрешается с помощью вновь созданного AuthProviderConfig при создании новой конфигурации поставщика.

Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .

Подпись:

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

Параметры

Возврат:

Обещание < AuthProviderConfig >

Обещание, которое разрешается с помощью созданной конфигурации поставщика.

BaseAuth.createSessionCookie()

Создает новый файл cookie сеанса Firebase с указанными параметрами. Созданная строка JWT может быть установлена ​​как файл cookie сеанса на стороне сервера с настраиваемой политикой использования файлов cookie и использоваться для управления сеансом. Файл cookie сеанса JWT будет иметь те же требования к полезной нагрузке, что и предоставленный токен идентификатора.

Примеры кода и подробную документацию см. в разделе «Управление сеансовыми файлами cookie» .

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, которое выполняется в случае успеха с созданным файлом cookie сеанса.

BaseAuth.createUser()

Создает нового пользователя.

Примеры кода и подробную документацию см. в разделе Создание пользователя .

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

Обещание, выполненное с пользовательскими данными, соответствующими вновь созданному пользователю.

BaseAuth.deleteProviderConfig()

Удаляет конфигурацию провайдера, соответствующую переданному идентификатору провайдера. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found .

Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .

Подпись:

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

Параметры

Возврат:

Обещание<void>

Обещание, которое разрешается после завершения.

BaseAuth.deleteUser()

Удаляет существующего пользователя.

См. раздел Удаление пользователя для получения примеров кода и подробной документации.

Подпись:

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

Параметры

Возврат:

Обещание<void>

Пустое обещание выполняется после удаления пользователя.

BaseAuth.deleteUsers()

Удаляет пользователей, указанных указанными идентификаторами.

Удаление несуществующего пользователя не приведет к возникновению ошибки (т. е. этот метод является идемпотентным). Несуществующие пользователи считаются успешно удаленными и поэтому учитываются в значении DeleteUsersResult.successCount .

Можно указать не более 1000 идентификаторов. Если указано более 1000 идентификаторов, этот метод выдает FirebaseAuthError.

В настоящее время скорость этого API на сервере ограничена 1 QPS. Если вы превысите это значение, вы можете получить сообщение об ошибке превышения квоты. Поэтому, если вы хотите удалить более 1000 пользователей, вам может потребоваться добавить задержку, чтобы не превысить этот предел.

Подпись:

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

Параметры

Возврат:

Обещание< DeleteUsersResult >

Обещание, которое разрешается как общее количество успешных/неудачных удалений, а также массив ошибок, соответствующий неудачным удалениям.

BaseAuth.generateEmailVerificationLink()

Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанный адрес электронной почты. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д.

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, которое разрешается с помощью созданной ссылки.

Пример

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
    });

BaseAuth.generatePasswordResetLink()

Создает ссылку на внешнее действие по электронной почте для сброса пароля пользователя. Ссылка генерируется для пользователя с указанным адресом электронной почты. Необязательный объект ActionCodeSettings определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д.

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, которое разрешается с помощью созданной ссылки.

Пример

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
    });

BaseAuth.generateSignInWithEmailLink()

Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанный адрес электронной почты. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д.

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, которое разрешается с помощью созданной ссылки.

Пример

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
    });

BaseAuth.generateVerifyAndChangeEmailLink()

Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанное электронное письмо. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д.

Подпись:

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

Параметры

Возврат:

Обещание<строка>

Обещание, которое разрешается с помощью созданной ссылки.

BaseAuth.getProviderConfig()

Ищет конфигурацию поставщика аутентификации по предоставленному идентификатору. Возвращает обещание, которое разрешается с конфигурацией поставщика, соответствующей указанному идентификатору поставщика. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found .

Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .

Подпись:

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

Параметры

Возврат:

Обещание < AuthProviderConfig >

Обещание, которое разрешается с конфигурацией, соответствующей предоставленному идентификатору.

Базааутус.getUser()

Получает пользовательские данные для пользователя, соответствующего заданному uid .

Примеры кода и подробную документацию см. в разделе Получение пользовательских данных .

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

Обещание, выполненное с пользовательскими данными, соответствующими предоставленному uid .

BaseAuth.getUserByEmail()

Получает пользовательские данные для пользователя, соответствующего данному адресу электронной почты.

Примеры кода и подробную документацию см. в разделе Получение пользовательских данных .

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

Обещание, выполненное с использованием пользовательских данных, соответствующих указанному адресу электронной почты.

BaseAuth.getUserByPhoneNumber()

Получает пользовательские данные для пользователя, соответствующего заданному номеру телефона. Номер телефона должен соответствовать спецификации E.164.

Примеры кода и подробную документацию см. в разделе Получение пользовательских данных .

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

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

BaseAuth.getUserByProviderUid()

Получает пользовательские данные для пользователя, соответствующего заданному идентификатору поставщика.

Примеры кода и подробную документацию см. в разделе Получение пользовательских данных .

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

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

BaseAuth.getUsers()

Получает данные пользователя, соответствующие указанным идентификаторам.

Нет никаких гарантий заказа; в частности, не гарантируется, что n-я запись в списке результатов будет соответствовать n-й записи в списке входных параметров.

Можно указать не более 100 идентификаторов. Если указано более 100 идентификаторов, этот метод выдает FirebaseAuthError.

Подпись:

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

Параметры

Возврат:

Обещание < GetUsersResult >

Обещание, которое разрешается в соответствующие записи пользователя.

Исключения

FirebaseAuthError Если какой-либо из идентификаторов недействителен или указано более 100 идентификаторов.

BaseAuth.importUsers()

Импортирует предоставленный список пользователей в Firebase Auth. Одновременно можно импортировать не более 1000 пользователей. При импорте пользователей с паролями необходимо указать UserImportOptions . Эта операция оптимизирована для массового импорта и игнорирует проверки uid , email и другие уникальные идентификаторы, которые могут привести к дублированию.

Подпись:

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

Параметры

Возврат:

Обещание < UserImportResult >

Обещание, которое выполняется после завершения операции с результатом импорта. Сюда входит количество успешных импортов, количество неудачных импортов и соответствующие ошибки.

BaseAuth.listProviderConfigs()

Возвращает список существующих конфигураций поставщика, соответствующих предоставленному фильтру. Одновременно можно указать не более 100 конфигураций провайдера.

Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .

Подпись:

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

Параметры

Возврат:

Обещание < ListProviderConfigResults >

Обещание, которое разрешается со списком конфигураций поставщика, соответствующих требованиям фильтра.

BaseAuth.listUsers()

Получает список пользователей (только один пакет) с размером maxResults начиная со смещения, указанного в pageToken . Это используется для пакетного получения всех пользователей указанного проекта.

См. список всех пользователей для получения примеров кода и подробной документации.

Подпись:

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

Параметры

Возврат:

Обещание < ListUsersResult >

Обещание, которое разрешается с учетом текущей партии загруженных пользователей и токена следующей страницы.

BaseAuth.revokeRefreshTokens()

Отменяет все токены обновления для существующего пользователя.

Этот API обновит UserRecord.tokensValidAfterTime пользователя до текущего времени в формате UTC. Важно, чтобы на сервере, на котором это вызывается, часы были установлены правильно и синхронизированы.

Хотя это приведет к отмене всех сеансов для указанного пользователя и отключению создания любых новых токенов идентификаторов для существующих сеансов, существующие токены идентификаторов могут оставаться активными до истечения их естественного срока действия (один час). Чтобы убедиться, что токены идентификатора отозваны, используйте BaseAuth.verifyIdToken() , где для checkRevoked установлено значение true.

Подпись:

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

Параметры

Возврат:

Обещание<void>

Пустое обещание, выполняемое после отзыва токенов обновления пользователя.

BaseAuth.setCustomUserClaims()

Устанавливает дополнительные претензии разработчика для существующего пользователя, определенного предоставленным идентификатором uid , обычно используется для определения ролей пользователей и уровней доступа. Эти утверждения должны распространяться на все устройства, на которых пользователь уже вошел в систему (после истечения срока действия токена или при принудительном обновлении токена) и при следующем входе пользователя в систему. Если используется зарезервированное имя утверждения OIDC (sub, iat, iss и т. д.). ), выдается ошибка. Они устанавливаются на токене идентификатора аутентифицированного пользователя JWT.

Примеры кода и подробную документацию см. в разделе Определение ролей пользователей и уровней доступа .

Подпись:

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

Параметры

Возврат:

Обещание<void>

Обещание, которое выполняется при успешном завершении операции.

BaseAuth.updateProviderConfig()

Возвращает обещание, которое разрешается с помощью обновленного AuthProviderConfig соответствующего указанному идентификатору поставщика. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found .

Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .

Подпись:

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

Параметры

Возврат:

Обещание < AuthProviderConfig >

Обещание, которое разрешается с помощью обновленной конфигурации поставщика.

BaseAuth.updateUser()

Обновляет существующего пользователя.

См. раздел Обновление пользователя для получения примеров кода и подробной документации.

Подпись:

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

Параметры

Возврат:

Обещание < UserRecord >

Обещание выполнено с обновленными пользовательскими данными.

BaseAuth.verifyIdToken()

Проверяет токен идентификатора Firebase (JWT). Если токен действителен, обещание выполняется с помощью декодированных утверждений токена; в противном случае обещание отклоняется.

Если для checkRevoked установлено значение true, сначала проверяется, отключен ли соответствующий пользователь. Если да, выдается ошибка auth/user-disabled . Если нет, проверяется, был ли отозван сеанс, соответствующий токену идентификатора. Если сеанс соответствующего пользователя признан недействительным, выдается ошибка auth/id-token-revoked . Если не указано, проверка не применяется.

Примеры кода и подробную документацию см. в разделе «Проверка токенов идентификатора» .

Подпись:

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

Параметры

Возврат:

Обещание < DecodedIdToken >

Обещание, выполненное с помощью декодированных утверждений токена, если токен идентификатора действителен; в противном случае — отклоненное обещание.

BaseAuth.verifySessionCookie()

Проверяет файл cookie сеанса Firebase. Возвращает обещание с утверждениями о файлах cookie. Отклоняет обещание, если файл cookie не может быть проверен.

Если для checkRevoked установлено значение true, сначала проверяется, отключен ли соответствующий пользователь: если да, выдается ошибка auth/user-disabled . Если нет, проверяется, был ли отозван сеанс, соответствующий файлу cookie сеанса. Если сеанс соответствующего пользователя признан недействительным, выдается ошибка auth/session-cookie-revoked . Если не указано, проверка не производится.

См. раздел «Проверка файлов cookie сеанса» для получения примеров кода и подробной документации.

Подпись:

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

Параметры

Возврат:

Обещание < DecodedIdToken >

Обещание, выполненное с помощью декодированных утверждений файла cookie сеанса, если файл cookie сеанса действителен; в противном случае — отклоненное обещание.