Интерфейс Auth с учетом арендаторов, используемый для управления пользователями, настройки поставщиков SAML/OIDC, создания ссылок электронной почты для сброса пароля, проверки электронной почты и т. д. для конкретных арендаторов.
Для поддержки мультитенантности требуется платформа идентификации Google Cloud (GCIP). Дополнительную информацию о GCIP, включая цены и функции, см. в документации GCIP. .
Каждый арендатор содержит собственных поставщиков удостоверений, настройки и наборы пользователей. Использование TenantAwareAuth , можно также управлять пользователями для конкретного клиента и соответствующими конфигурациями OIDC/SAML, можно проверять токены идентификаторов для пользователей, вошедших в определенный клиент, а также можно создавать ссылки на действия по электронной почте для пользователей, принадлежащих этому арендатору.
Экземпляры TenantAwareAuth для определенного tenantId можно создать, вызвав TenantManager.authForTenant(). .
Подпись:
export declare class TenantAwareAuth extends BaseAuth
Расширяет: BaseAuth
Характеристики
| Свойство | Модификаторы | Тип | Описание |
|---|---|---|---|
| идентификатор арендатора | нить | Идентификатор клиента, соответствующий этому экземпляру TenantAwareAuth . Все вызовы API управления пользователями, API управления поставщиками OIDC/SAML, API создания ссылок электронной почты и т. д. будут применяться только в рамках этого клиента. |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| createSessionCookie (idToken, sessionCookieOptions) | Создает новый файл cookie сеанса Firebase с указанными параметрами. Созданная строка JWT может быть установлена как файл cookie сеанса на стороне сервера с настраиваемой политикой использования файлов cookie и использоваться для управления сеансом. Файл cookie сеанса JWT будет иметь те же требования к полезной нагрузке, что и предоставленный токен идентификатора. Примеры кода и подробную документацию см. в разделе «Управление сеансовыми файлами cookie» . | |
| 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 сеанса» для получения примеров кода и подробной документации. |
TenantAwareAuth.tenantId
Идентификатор клиента, соответствующий этому экземпляру TenantAwareAuth . Все вызовы API управления пользователями, API управления поставщиками OIDC/SAML, API создания ссылок электронной почты и т. д. будут применяться только в рамках этого клиента.
Подпись:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Создает новый файл cookie сеанса Firebase с указанными параметрами. Созданная строка JWT может быть установлена как файл cookie сеанса на стороне сервера с настраиваемой политикой использования файлов cookie и использоваться для управления сеансом. Файл cookie сеанса JWT будет иметь те же требования к полезной нагрузке, что и предоставленный токен идентификатора.
Примеры кода и подробную документацию см. в разделе «Управление сеансовыми файлами cookie» .
Подпись:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| idToken | нить | Токен Firebase ID для обмена на файл cookie сеанса. |
| сессияCookieOptions | Сеанскукиеопционс | Параметры файлов cookie сеанса, которые включают настраиваемую продолжительность сеанса. |
Возврат:
Обещание<строка>
Обещание, которое выполняется в случае успеха с созданным файлом cookie сеанса.
ТенантАвареАус.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 >
Обещание, выполненное с помощью декодированных утверждений токена, если токен идентификатора действителен; в противном случае — отклоненное обещание.
TenantAwareAuth.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 сеанса действителен; в противном случае — отклоненное обещание.