TenantManager class

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

• Возможность создавать, обновлять, составлять список, получать и удалять арендаторов для базового проекта.
• Получение экземпляра TenantAwareAuth для выполнения операций, связанных с аутентификацией (управление пользователями, управление конфигурацией поставщика, проверка токена, создание ссылок электронной почты и т. д.) в контексте указанного клиента.

Подпись:

export declare class TenantManager 

Методы

Метод	Модификаторы	Описание
authForTenant (идентификатор арендатора)		Возвращает экземпляр TenantAwareAuth , привязанный к данному идентификатору клиента.
createTenant (опционы арендатора)		Создает нового арендатора. При создании новых клиентов арендаторам, использующим отдельные счета и квоты, потребуется собственный проект, который должен быть определен как full_service .
deleteTenant (идентификатор арендатора)		Удаляет существующего арендатора.
getTenant (идентификатор арендатора)		Получает конфигурацию клиента, соответствующую данному tenantId .
listTenants (maxResults, pageToken)		Получает список клиентов (только один пакет) с размером maxResults начиная со смещения, указанного в pageToken . Это используется для пакетного получения всех арендаторов указанного проекта.
updateTenant (tenantId, tenantOptions)		Обновляет существующую конфигурацию клиента.

ТенантМенеджер.authForTenant()

Возвращает экземпляр TenantAwareAuth , привязанный к данному идентификатору клиента.

Подпись:

authForTenant(tenantId: string): TenantAwareAuth;

Параметры

Параметр	Тип	Описание
идентификатор арендатора	нить	Идентификатор клиента, экземпляр TenantAwareAuth которого должен быть возвращен.

Возврат:

TenantAwareAuth

Экземпляр TenantAwareAuth , соответствующий этому идентификатору клиента.

ТенантМенеджер.createTenant()

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

Подпись:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

Параметры

Параметр	Тип	Описание
Опции арендатора	Создание запроса арендатора	Свойства, которые необходимо задать в новой создаваемой конфигурации клиента.

Возврат:

Обещание < Арендатор >

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

ТенантМенеджер.deleteTenant()

Удаляет существующего клиента.

Подпись:

deleteTenant(tenantId: string): Promise<void>;

Параметры

Параметр	Тип	Описание
идентификатор арендатора	нить	tenantId , соответствующий удаляемому арендатору.

Возврат:

Обещание<void>

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

ТенантМенеджер.getTenant()

Получает конфигурацию клиента, соответствующую данному tenantId .

Подпись:

getTenant(tenantId: string): Promise<Tenant>;

Параметры

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

Возврат:

Обещание< Арендатор >

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

TenantManager.listTenants()

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

Подпись:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

Параметры

Параметр	Тип	Описание
maxResults	число	Размер страницы, 1000, если не определен. Это также максимально допустимый предел.
pageToken	нить	Токен следующей страницы. Если не указано, возвращает арендаторов, начиная с без смещения.

Возврат:

Обещание < ListTenantsResult >

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

ТенантМенеджер.обновлениеТенант()

Обновляет существующую конфигурацию клиента.

Подпись:

updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;

Параметры

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

Возврат:

Обещание< Арендатор >

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