Definiuje menedżera dzierżawy używanego do zarządzania operacjami związanymi z dzierżawą. To zawiera:
- Możliwość tworzenia, aktualizowania, wyświetlania, pobierania i usuwania najemców projektu bazowego.
- Pobieranie instancji
TenantAwareAuth
do uruchamiania operacji związanych z uwierzytelnianiem (zarządzanie użytkownikami, zarządzanie konfiguracją dostawcy, weryfikacja tokena, generowanie łącza e-mail itp.) w kontekście określonej dzierżawy.
Podpis:
export declare class TenantManager
Metody
metoda | Modyfikatory | Opis |
---|---|---|
authForTenant(identyfikator najemcy) | Zwraca instancję TenantAwareAuth powiązaną z danym identyfikatorem dzierżawy. | |
utwórzTenant(opcje najemcy) | Tworzy nowego dzierżawcę. Podczas tworzenia nowych dzierżawców, dzierżawcy korzystający z oddzielnych rozliczeń i przydziałów będą wymagać własnego projektu i muszą być zdefiniowani jako full_service . | |
usuńTenanta(identyfikator najemcy) | Usuwa istniejącego dzierżawcę. | |
getTenant(identyfikator najemcy) | Pobiera konfigurację dzierżawy dla dzierżawy odpowiadającą danemu tenantId . | |
listTenants(maxResults, pageToken) | Pobiera listę dzierżaw (tylko pojedyncza partia) o rozmiarze maxResults , zaczynając od przesunięcia określonego przez pageToken . Służy do pobierania wszystkich najemców określonego projektu partiami. | |
updateTenant(identyfikator najemcy, opcje najemcy) | Aktualizuje istniejącą konfigurację dzierżawy. |
TenantManager.authForTenant()
Zwraca instancję TenantAwareAuth
powiązaną z danym identyfikatorem dzierżawy.
Podpis:
authForTenant(tenantId: string): TenantAwareAuth;
Parametry
Parametr | Typ | Opis |
---|---|---|
identyfikator najemcy | strunowy | Identyfikator dzierżawy, którego wystąpienie TenantAwareAuth ma zostać zwrócone. |
Zwroty:
Wystąpienie TenantAwareAuth
odpowiadające temu identyfikatorowi dzierżawy.
TenantManager.createTenant()
Tworzy nowego dzierżawcę. Podczas tworzenia nowych dzierżawców, dzierżawcy korzystający z oddzielnych rozliczeń i przydziałów będą wymagać własnego projektu i muszą być zdefiniowani jako full_service
.
Podpis:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
Parametry
Parametr | Typ | Opis |
---|---|---|
Opcje najemcy | Utwórz żądanie najemcy | Właściwości do ustawienia w nowej konfiguracji dzierżawy, która ma zostać utworzona. |
Zwroty:
Obietnica < Najemca >
Obietnica spełniona dzięki konfiguracji najemcy odpowiadającej nowo utworzonemu najemcy.
TenantManager.deleteTenant()
Usuwa istniejącego dzierżawcę.
Podpis:
deleteTenant(tenantId: string): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
identyfikator najemcy | strunowy | tenantId odpowiadający dzierżawcy do usunięcia. |
Zwroty:
Obietnica<pusta>
Pusta obietnica spełniona po usunięciu najemcy.
TenantManager.getTenant()
Pobiera konfigurację dzierżawy dla dzierżawy odpowiadającą danemu tenantId
.
Podpis:
getTenant(tenantId: string): Promise<Tenant>;
Parametry
Parametr | Typ | Opis |
---|---|---|
identyfikator najemcy | strunowy | Identyfikator dzierżawy odpowiadający dzierżawcy, którego dane mają zostać pobrane. |
Zwroty:
Obietnica < Najemca >
Obietnica spełniona w konfiguracji dzierżawy dla podanego tenantId
.
TenantManager.listTenants()
Pobiera listę dzierżaw (tylko pojedyncza partia) o rozmiarze maxResults
, zaczynając od przesunięcia określonego przez pageToken
. Służy do pobierania wszystkich najemców określonego projektu partiami.
Podpis:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
Parametry
Parametr | Typ | Opis |
---|---|---|
maxWyniki | numer | Rozmiar strony, 1000, jeśli nieokreślony. Jest to również maksymalny dozwolony limit. |
token strony | strunowy | Żeton następnej strony. Jeśli nie określono, zwraca dzierżawców rozpoczynających się bez żadnego przesunięcia. |
Zwroty:
Obietnica< ListTenantsResult >
Obietnica, która jest rozwiązywana za pomocą partii pobranych dzierżawców i tokenu następnej strony.
TenantManager.updateTenant()
Aktualizuje istniejącą konfigurację dzierżawy.
Podpis:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
Parametry
Parametr | Typ | Opis |
---|---|---|
identyfikator najemcy | strunowy | tenantId odpowiadający dzierżawcy do usunięcia. |
Opcje najemcy | Aktualizuj żądanie najemcy | Właściwości do zaktualizowania w podanej dzierżawie. |
Zwroty:
Obietnica < Najemca >
Obietnica spełniona dzięki aktualizacji danych najemcy.