TenantManager class

Definiuje menedżera najemcy używanego do zarządzania operacjami związanymi z najemcami. Obejmuje to:

• Możliwość tworzenia, aktualizowania, wyświetlania, pobierania i usuwania najemców bazowego projektu.
• Uzyskiwanie instancji TenantAwareAuth na potrzeby operacji związanych z uwierzytelnianiem (zarządzanie użytkownikami, zarządzanie konfiguracją dostawcy, weryfikacja tokenów, generowanie linku e-mail itp.) w kontekście określonego najemcy.

Podpis:

export declare class TenantManager 

Metody

Metoda	Modyfikatory	Opis
authForTenant(tenantId)		Zwraca instancję TenantAwareAuth powiązaną z podanym identyfikatorem najemcy.
createTenant(tenantOptions),		Tworzy nowego najemcę. Podczas tworzenia nowych najemców, którzy korzystają z osobnych płatności i limitów, trzeba mieć własny projekt i muszą być zdefiniowane jako full_service.
deleteTenant(tenantId)		Usuwa istniejącego najemcę.
getTenant(tenantId),		Pobiera konfigurację najemcy dla najemcy odpowiadającego określonemu obiektowi tenantId.
listTenants(maxResults, pageToken)		Pobiera listę najemców (tylko jedna wsad) o rozmiarze maxResults, zaczynając od przesunięcia określonego przez pageToken. Służy do pobierania partiami wszystkich najemców określonego projektu.
updateTenant(tenantId, tenantOptions)		Aktualizuje istniejącą konfigurację najemcy.

TenantManager.authForTenant()

Zwraca instancję TenantAwareAuth powiązaną z podanym identyfikatorem najemcy.

Podpis:

authForTenant(tenantId: string): TenantAwareAuth;

Parametry

Parametr	Typ	Opis
identyfikator najemcy	ciąg znaków	Identyfikator najemcy, którego instancja TenantAwareAuth ma zostać zwrócona.

Zwroty:

TenantAwareAuth

Instancja TenantAwareAuth odpowiadająca temu identyfikatorowi najemcy.

TenantManager.createTenant()

Tworzy nowego najemcę. Podczas tworzenia nowych najemców, którzy korzystają z osobnych rozliczeń i limitów, będą potrzebowali własnego projektu i muszą być zdefiniowani jako full_service.

Podpis:

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

Parametry

Parametr	Typ	Opis
Opcje najemcy	CreateTenantRequest	Właściwości do ustawienia w nowej konfiguracji najemcy.

Zwroty:

Obietnica<najemca>

Obietnica zrealizowana z konfiguracją najemcy odpowiadającą nowo utworzonego najemcy.

TenantManager.deleteTenant()

Usuwa istniejącego najemcę.

Podpis:

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

Parametry

Parametr	Typ	Opis
identyfikator najemcy	ciąg znaków	tenantId odpowiadający najemcy do usunięcia.

Zwroty:

Obietnica<void>

Pusta obietnica spełniona po usunięciu najemcy.

TenantManager.getTenant()

Pobiera konfigurację najemcy dla danej tenantId.

Podpis:

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

Parametry

Parametr	Typ	Opis
identyfikator najemcy	ciąg znaków	Identyfikator najemcy odpowiadający najemcy, którego dane mają zostać pobrane.

Zwroty:

Obietnica<najemca>

Obietnica spełniona przez konfigurację najemcy w podanym tenantId.

TenantManager.listTenants()

Pobiera listę najemców (tylko jedna wsad) o rozmiarze maxResults, zaczynając od przesunięcia określonego przez pageToken. Służy do pobierania partiami wszystkich najemców określonego projektu.

Podpis:

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

Parametry

Parametr	Typ	Opis
maxResults	liczba	Rozmiar strony (1000), jeśli nie został zdefiniowany. Jest to również maksymalny dozwolony limit.
pageToken (Token strony)	ciąg znaków	Token następnej strony. Jeśli nie określono tego ustawienia, zwraca najemców, których wartość zaczyna się bez przesunięcia.

Zwroty:

Obietnica<ListTenantsResult>

Obietnica, która kończy się z grupą pobranych najemców i tokena następnej strony.

TenantManager.updateTenant()

Aktualizuje istniejącą konfigurację najemcy.

Podpis:

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

Parametry

Parametr	Typ	Opis
identyfikator najemcy	ciąg znaków	tenantId odpowiadający najemcy do usunięcia.
Opcje najemcy	UpdateTenantRequest	Właściwości do zaktualizowania na podanym najemcy.

Zwroty:

Obietnica<najemca>

Obietnica spełniona dzięki aktualizacji danych najemcy.