Общий родительский интерфейс для API Auth и TenantAwareAuth .
Подпись:
export declare abstract class BaseAuth
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| createCustomToken (uid, DeveloperClaims) | Создает новый пользовательский токен Firebase (JWT), который можно отправить обратно на клиентское устройство и использовать для входа в систему с помощью методов signInWithCustomToken() клиентских SDK. (Экземпляры с поддержкой клиента также будут встраивать идентификатор клиента в токен.) Примеры кода и подробную документацию см. в разделе Создание пользовательских токенов. | |
| createProviderConfig (конфигурация) | Возвращает обещание, которое разрешается с помощью вновь созданного AuthProviderConfig при создании новой конфигурации поставщика. Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . | |
| createSessionCookie (idToken, sessionCookieOptions) | Создает новый файл cookie сеанса Firebase с указанными параметрами. Созданная строка JWT может быть установлена как файл cookie сеанса на стороне сервера с настраиваемой политикой использования файлов cookie и использоваться для управления сеансом. Файл cookie сеанса JWT будет иметь те же требования к полезной нагрузке, что и предоставленный токен идентификатора. Примеры кода и подробную документацию см. в разделе «Управление сеансовыми файлами cookie» . | |
| createUser (свойства) | Создает нового пользователя. Примеры кода и подробную документацию см. в разделе Создание пользователя . | |
| deleteProviderConfig (идентификатор поставщика) | Удаляет конфигурацию провайдера, соответствующую переданному идентификатору провайдера. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found . Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . | |
| удалитьПользователь (UID) | Удаляет существующего пользователя. См. раздел Удаление пользователя для получения примеров кода и подробной документации. | |
| удалитьПользователи (uids) | Удаляет пользователей, указанных указанными идентификаторами. Удаление несуществующего пользователя не приведет к возникновению ошибки (т. е. этот метод является идемпотентным). Несуществующие пользователи считаются успешно удаленными и поэтому учитываются в значении DeleteUsersResult.successCount . Можно указать не более 1000 идентификаторов. Если указано более 1000 идентификаторов, этот метод выдает FirebaseAuthError. В настоящее время скорость этого API на сервере ограничена 1 QPS. Если вы превысите это значение, вы можете получить сообщение об ошибке превышения квоты. Поэтому, если вы хотите удалить более 1000 пользователей, вам может потребоваться добавить задержку, чтобы не превысить этот предел. | |
| генерироватьEmailVerificationLink (электронная почта, actionCodeSettings) | Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанный адрес электронной почты. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д. | |
| генерироватьPasswordResetLink (электронная почта, actionCodeSettings) | Создает ссылку на внешнее действие по электронной почте для сброса пароля пользователя. Ссылка генерируется для пользователя с указанным адресом электронной почты. Необязательный объект ActionCodeSettings определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д. | |
| генерироватьSignInWithEmailLink (электронная почта, actionCodeSettings) | Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанный адрес электронной почты. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д. | |
| генерироватьVerifyAndChangeEmailLink (электронная почта, newEmail, actionCodeSettings) | Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанное электронное письмо. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д. | |
| getProviderConfig (идентификатор поставщика) | Ищет конфигурацию поставщика аутентификации по предоставленному идентификатору. Возвращает обещание, которое разрешается с конфигурацией поставщика, соответствующей указанному идентификатору поставщика. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found . Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . | |
| getUser (UID) | Получает пользовательские данные для пользователя, соответствующего заданному uid . Примеры кода и подробную документацию см. в разделе Получение пользовательских данных . | |
| getUserByEmail (электронная почта) | Получает пользовательские данные для пользователя, соответствующего данному адресу электронной почты. Примеры кода и подробную документацию см. в разделе Получение пользовательских данных . | |
| getUserByPhoneNumber (номер телефона) | Получает пользовательские данные для пользователя, соответствующего заданному номеру телефона. Номер телефона должен соответствовать спецификации E.164. Примеры кода и подробную документацию см. в разделе Получение пользовательских данных . | |
| getUserByProviderUid (providerId, uid) | Получает пользовательские данные для пользователя, соответствующего заданному идентификатору поставщика. Примеры кода и подробную документацию см. в разделе Получение пользовательских данных . | |
| getUsers (идентификаторы) | Получает пользовательские данные, соответствующие указанным идентификаторам. Нет никаких гарантий заказа; в частности, не гарантируется, что n-я запись в списке результатов будет соответствовать n-й записи в списке входных параметров. Можно указать не более 100 идентификаторов. Если указано более 100 идентификаторов, этот метод выдает FirebaseAuthError. | |
| importUsers(пользователи, параметры) | Импортирует предоставленный список пользователей в Firebase Auth. Одновременно можно импортировать не более 1000 пользователей. При импорте пользователей с паролями необходимо указать UserImportOptions . Эта операция оптимизирована для массового импорта и игнорирует проверки уникальности uid , email и других идентификаторов, что может привести к дублированию. | |
| listProviderConfigs (параметры) | Возвращает список существующих конфигураций поставщика, соответствующих предоставленному фильтру. Одновременно можно указать не более 100 конфигураций провайдера. Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . | |
| listUsers (maxResults, pageToken) | Получает список пользователей (только одиночный пакет) с размером maxResults начиная со смещения, указанного в pageToken . Это используется для пакетного получения всех пользователей указанного проекта. См. список всех пользователей для получения примеров кода и подробной документации. | |
| отозватьRefreshTokens (uid) | Отменяет все токены обновления для существующего пользователя. Этот API обновит UserRecord.tokensValidAfterTime пользователя до текущего времени в формате UTC. Важно, чтобы на сервере, на котором это вызывается, часы были установлены правильно и синхронизированы. Хотя это приведет к отмене всех сеансов для указанного пользователя и отключению создания любых новых токенов идентификаторов для существующих сеансов, существующие токены идентификаторов могут оставаться активными до истечения их естественного срока действия (один час). Чтобы убедиться, что токены идентификатора отозваны, используйте BaseAuth.verifyIdToken() , где для checkRevoked установлено значение true. | |
| setCustomUserClaims (uid, customUserClaims) | Устанавливает дополнительные утверждения разработчика для существующего пользователя, идентифицируемого предоставленным uid , который обычно используется для определения ролей пользователя и уровней доступа. Эти утверждения должны распространяться на все устройства, на которых пользователь уже вошел в систему (после истечения срока действия токена или при принудительном обновлении токена) и при следующем входе пользователя в систему. Если используется зарезервированное имя утверждения OIDC (sub, iat, iss и т. д.). ), выдается ошибка. Они устанавливаются на токене идентификатора аутентифицированного пользователя JWT. Примеры кода и подробную документацию см. в разделе Определение ролей пользователей и уровней доступа . | |
| updateProviderConfig (идентификатор поставщика, обновленная конфигурация) | Возвращает обещание, которое разрешается с помощью обновленного AuthProviderConfig соответствующего указанному идентификатору поставщика. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found . Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. . | |
| updateUser (uid, свойства) | Обновляет существующего пользователя. Примеры кода и подробную документацию см. в разделе Обновление пользователя . | |
| verifyIdToken(idToken, checkRevoked) | Проверяет токен идентификатора Firebase (JWT). Если токен действителен, обещание выполняется с помощью декодированных утверждений токена; в противном случае обещание отклоняется. Если для checkRevoked установлено значение true, сначала проверяется, отключен ли соответствующий пользователь. Если да, выдается ошибка auth/user-disabled . Если нет, проверяется, был ли отозван сеанс, соответствующий токену идентификатора. Если сеанс соответствующего пользователя признан недействительным, выдается ошибка auth/id-token-revoked . Если не указано, проверка не применяется. Примеры кода и подробную документацию см. в разделе «Проверка токенов идентификатора» . | |
| verifySessionCookie(sessionCookie, checkRevoked) | Проверяет файл cookie сеанса Firebase. Возвращает обещание с утверждениями о файлах cookie. Отклоняет обещание, если файл cookie не может быть проверен. Если для checkRevoked установлено значение true, сначала проверяется, отключен ли соответствующий пользователь: если да, выдается ошибка auth/user-disabled . Если нет, проверяется, был ли отозван сеанс, соответствующий файлу cookie сеанса. Если сеанс соответствующего пользователя признан недействительным, выдается ошибка auth/session-cookie-revoked . Если не указано, проверка не производится. См. раздел «Проверка файлов cookie сеанса» для получения примеров кода и подробной документации. |
BaseAuth.createCustomToken()
Создает новый пользовательский токен Firebase (JWT), который можно отправить обратно на клиентское устройство и использовать для входа в систему с помощью методов signInWithCustomToken() клиентских SDK. (Экземпляры с поддержкой клиента также будут встраивать идентификатор клиента в токен.)
Примеры кода и подробную документацию см. в разделе Создание пользовательских токенов.
Подпись:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid который будет использоваться в качестве темы пользовательского токена. |
| Претензии разработчика | объект | Необязательные дополнительные утверждения для включения в полезную нагрузку пользовательского токена. |
Возврат:
Обещание<строка>
Обещание, выполненное с помощью специального токена для предоставленного 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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| idToken | нить | Токен Firebase ID для обмена на файл cookie сеанса. |
| сессияCookieOptions | Сеанскукиопционс | Параметры файлов cookie сеанса, которые включают настраиваемую продолжительность сеанса. |
Возврат:
Обещание<строка>
Обещание, которое выполняется в случае успеха с созданным файлом 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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid , соответствующий удаляемому пользователю. |
Возврат:
Обещание<void>
Пустое обещание выполняется после удаления пользователя.
BaseAuth.deleteUsers()
Удаляет пользователей, указанных указанными идентификаторами.
Удаление несуществующего пользователя не приведет к возникновению ошибки (т. е. этот метод является идемпотентным). Несуществующие пользователи считаются успешно удаленными и поэтому учитываются в значении DeleteUsersResult.successCount .
Можно указать не более 1000 идентификаторов. Если указано более 1000 идентификаторов, этот метод выдает FirebaseAuthError.
В настоящее время скорость этого API на сервере ограничена 1 QPS. Если вы превысите это значение, вы можете получить сообщение об ошибке превышения квоты. Поэтому, если вы хотите удалить более 1000 пользователей, вам может потребоваться добавить задержку, чтобы не превысить этот предел.
Подпись:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкости | нить[] | uids , соответствующие удаляемым пользователям. |
Возврат:
Обещание< DeleteUsersResult >
Обещание, которое разрешается как общее количество успешных/неудачных удалений, а также массив ошибок, соответствующий неудачным удалениям.
BaseAuth.generateEmailVerificationLink()
Создает ссылку на внешнее действие по электронной почте, чтобы подтвердить право собственности пользователя на указанный адрес электронной почты. Объект ActionCodeSettings , предоставленный в качестве аргумента этому методу, определяет, должна ли ссылка обрабатываться мобильным приложением или браузером, а также дополнительная информация о состоянии, которая должна передаваться в глубокой ссылке и т. д.
Подпись:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| электронная почта | нить | Учетная запись электронной почты для подтверждения. |
| Настройки кода действия | Параметры кода действия | Настройки кода действия. Если указано, URL-адрес состояния/продолжения задается как параметр «continueUrl» в ссылке для проверки электронной почты. Целевая страница проверки электронной почты по умолчанию будет использовать это для отображения ссылки для возврата в приложение, если оно установлено. Если actionCodeSettings не указан, к URL-адресу действия не добавляется URL-адрес. Предоставленный URL-адрес состояния должен принадлежать домену, который внесен разработчиком в белый список в консоли. В противном случае выдается ошибка. Перенаправления в мобильных приложениях применимы только в том случае, если разработчик настроил и принял условия обслуживания Firebase Dynamic Links. Имя пакета Android и идентификатор пакета iOS учитываются, только если они настроены в одном проекте Firebase Auth. |
Возврат:
Обещание<строка>
Обещание, которое разрешается с помощью созданной ссылки.
Пример
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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| электронная почта | нить | Адрес электронной почты пользователя, пароль которого необходимо сбросить. |
| Настройки кода действия | Параметры кода действия | Настройки кода действия. Если указано, URL-адрес состояния/продолжения задается как параметр «continueUrl» в ссылке для сброса пароля. Целевая страница сброса пароля по умолчанию будет использовать это для отображения ссылки для возврата в приложение, если оно установлено. Если actionCodeSettings не указан, к URL-адресу действия не добавляется URL-адрес. Предоставленный URL-адрес состояния должен принадлежать домену, который внесен разработчиком в белый список в консоли. В противном случае выдается ошибка. Перенаправления в мобильных приложениях применимы только в том случае, если разработчик настроил и принял условия обслуживания Firebase Dynamic Links. Имя пакета Android и идентификатор пакета iOS учитываются, только если они настроены в одном проекте Firebase Auth. |
Возврат:
Обещание<строка>
Обещание, которое разрешается с помощью созданной ссылки.
Пример
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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| электронная почта | нить | Учетная запись электронной почты для подтверждения. |
| Настройки кода действия | Параметры кода действия | Настройки кода действия. Если указано, URL-адрес состояния/продолжения задается как параметр «continueUrl» в ссылке для проверки электронной почты. Целевая страница проверки электронной почты по умолчанию будет использовать это для отображения ссылки для возврата в приложение, если оно установлено. Если actionCodeSettings не указан, к URL-адресу действия не добавляется URL-адрес. Предоставленный URL-адрес состояния должен принадлежать домену, который внесен разработчиком в белый список в консоли. В противном случае выдается ошибка. Перенаправления в мобильных приложениях применимы только в том случае, если разработчик настроил и принял условия обслуживания Firebase Dynamic Links. Имя пакета Android и идентификатор пакета iOS учитываются, только если они настроены в одном проекте Firebase Auth. |
Возврат:
Обещание<строка>
Обещание, которое разрешается с помощью созданной ссылки.
Пример
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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| электронная почта | нить | Текущая учетная запись электронной почты. |
| новыйЭлектронная почта | нить | Адрес электронной почты, на который обновляется учетная запись. |
| Настройки кода действия | Параметры кода действия | Настройки кода действия. Если указано, URL-адрес состояния/продолжения задается как параметр «continueUrl» в ссылке для проверки электронной почты. Целевая страница проверки электронной почты по умолчанию будет использовать это для отображения ссылки для возврата в приложение, если оно установлено. Если actionCodeSettings не указан, к URL-адресу действия не добавляется URL-адрес. Предоставленный URL-адрес состояния должен принадлежать домену, авторизованному в консоли, иначе будет выдана ошибка. Перенаправления в мобильных приложениях применимы только в том случае, если разработчик настроил и принял условия обслуживания Firebase Dynamic Links. Имя пакета Android и идентификатор пакета iOS учитываются, только если они настроены в одном проекте Firebase Auth. |
Возврат:
Обещание<строка>
Обещание, которое разрешается с помощью созданной ссылки.
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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid , соответствующий пользователю, данные которого необходимо получить. |
Возврат:
Обещание < 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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| идентификатор поставщика | нить | Идентификатор провайдера, например «google.com» для провайдера Google. |
| жидкость | нить | Идентификатор пользователя для данного провайдера. |
Возврат:
Обещание < UserRecord >
Обещание, выполненное с пользовательскими данными, соответствующими данному идентификатору провайдера.
BaseAuth.getUsers()
Получает данные пользователя, соответствующие указанным идентификаторам.
Нет никаких гарантий заказа; в частности, не гарантируется, что n-я запись в списке результатов будет соответствовать n-й записи в списке входных параметров.
Можно указать не более 100 идентификаторов. Если указано более 100 идентификаторов, этот метод выдает FirebaseAuthError.
Подпись:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| идентификаторы | Идентификатор пользователя [] | Идентификаторы, используемые для указания того, какие записи пользователей должны быть возвращены. Должно быть не более 100 записей. |
Возврат:
Обещание < GetUsersResult >
Обещание, которое разрешается в соответствующие записи пользователя.
Исключения
FirebaseAuthError Если какой-либо из идентификаторов недействителен или указано более 100 идентификаторов.
BaseAuth.importUsers()
Импортирует предоставленный список пользователей в Firebase Auth. Одновременно можно импортировать не более 1000 пользователей. При импорте пользователей с паролями необходимо указать UserImportOptions . Эта операция оптимизирована для массового импорта и игнорирует проверки uid , email и другие уникальные идентификаторы, которые могут привести к дублированию.
Подпись:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| пользователи | Усеримпортрекорд [] | Список записей пользователей для импорта в Firebase Auth. |
| параметры | Параметры импорта пользователя | Параметры импорта пользователей, необходимые, если предоставленные пользователи включают учетные данные с паролем. |
Возврат:
Обещание < 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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| maxResults | число | Размер страницы, 1000, если не определен. Это также максимально допустимый предел. |
| pageToken | нить | Токен следующей страницы. Если не указано, возвращает пользователей, начинающихся без смещения. |
Возврат:
Обещание < ListUsersResult >
Обещание, которое разрешается с учетом текущей партии загруженных пользователей и токена следующей страницы.
BaseAuth.revokeRefreshTokens()
Отменяет все токены обновления для существующего пользователя.
Этот API обновит UserRecord.tokensValidAfterTime пользователя до текущего времени в формате UTC. Важно, чтобы на сервере, на котором это вызывается, часы были установлены правильно и синхронизированы.
Хотя это приведет к отмене всех сеансов для указанного пользователя и отключению создания любых новых токенов идентификаторов для существующих сеансов, существующие токены идентификаторов могут оставаться активными до истечения их естественного срока действия (один час). Чтобы убедиться, что токены идентификатора отозваны, используйте BaseAuth.verifyIdToken() , где для checkRevoked установлено значение true.
Подпись:
revokeRefreshTokens(uid: string): Promise<void>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid , соответствующий пользователю, токены обновления которого должны быть отозваны. |
Возврат:
Обещание<void>
Пустое обещание, выполняемое после отзыва токенов обновления пользователя.
BaseAuth.setCustomUserClaims()
Устанавливает дополнительные претензии разработчика для существующего пользователя, определенного предоставленным идентификатором uid , обычно используется для определения ролей пользователей и уровней доступа. Эти утверждения должны распространяться на все устройства, на которых пользователь уже вошел в систему (после истечения срока действия токена или при принудительном обновлении токена) и при следующем входе пользователя в систему. Если используется зарезервированное имя утверждения OIDC (sub, iat, iss и т. д.). ), выдается ошибка. Они устанавливаются на токене идентификатора аутентифицированного пользователя JWT.
Примеры кода и подробную документацию см. в разделе Определение ролей пользователей и уровней доступа .
Подпись:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid пользователя, которого нужно редактировать. |
| CustomUserClaims | объект | нулевой | Разработчик утверждает, что установил. Если передано значение null, существующие пользовательские утверждения удаляются. Передача полезных данных настраиваемых утверждений размером более 1000 байт приведет к ошибке. Пользовательские утверждения добавляются к токену идентификатора пользователя, который передается при каждом подтвержденном запросе. Для атрибутов пользователя, не связанных с доступом к профилю, используйте базу данных или другие отдельные системы хранения. |
Возврат:
Обещание<void>
Обещание, которое выполняется при успешном завершении операции.
BaseAuth.updateProviderConfig()
Возвращает обещание, которое разрешается с помощью обновленного AuthProviderConfig соответствующего указанному идентификатору поставщика. Если указанный идентификатор не существует, выдается ошибка auth/configuration-not-found .
Для поддержки поставщиков SAML и OIDC требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .
Подпись:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| идентификатор поставщика | нить | Идентификатор поставщика, соответствующий конфигурации поставщика, которую необходимо обновить. |
| обновленоConfig | ОбновлениеAuthProviderRequest | Обновленная конфигурация. |
Возврат:
Обещание < AuthProviderConfig >
Обещание, которое разрешается с обновленной конфигурацией поставщика.
BaseAuth.updateUser()
Обновляет существующего пользователя.
См. раздел Обновление пользователя для получения примеров кода и подробной документации.
Подпись:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| жидкость | нить | uid , соответствующий пользователю, которого требуется обновить. |
| характеристики | Запрос обновления | Свойства, которые необходимо обновить для предоставленного пользователя. |
Возврат:
Обещание < UserRecord >
Обещание выполнено с обновленными пользовательскими данными.
BaseAuth.verifyIdToken()
Проверяет токен идентификатора Firebase (JWT). Если токен действителен, обещание выполняется с помощью декодированных утверждений токена; в противном случае обещание отклоняется.
Если для checkRevoked установлено значение true, сначала проверяется, отключен ли соответствующий пользователь. Если да, выдается ошибка auth/user-disabled . Если нет, проверяется, был ли отозван сеанс, соответствующий токену идентификатора. Если сеанс соответствующего пользователя признан недействительным, выдается ошибка auth/id-token-revoked . Если не указано, проверка не применяется.
Примеры кода и подробную документацию см. в разделе «Проверка токенов идентификатора» .
Подпись:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| idToken | нить | Идентификационный токен для проверки. |
| checkRevoked | логическое значение | Следует ли проверять, был ли отозван идентификационный токен. Для этого требуется дополнительный запрос к бэкэнду Firebase Auth, чтобы проверить время tokensValidAfterTime для соответствующего пользователя. Если не указано, эта дополнительная проверка не применяется. |
Возврат:
Обещание < 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>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| сеансCookie | нить | Файл cookie сеанса для проверки. |
| checkRevoked | логическое значение |
Возврат:
Обещание < DecodedIdToken >
Обещание, выполненное с помощью декодированных утверждений файла cookie сеанса, если файл cookie сеанса действителен; в противном случае — отклоненное обещание.