TenantManager class

Definisce il gestore tenant utilizzato per facilitare la gestione delle operazioni relative ai tenant. Ciò comprende:

• La possibilità di creare, aggiornare, elencare, ottenere ed eliminare tenant per il progetto sottostante.
• Ottenere un'istanza TenantAwareAuth per eseguire operazioni correlate all'autenticazione (gestione degli utenti, gestione della configurazione del provider, verifica dei token, generazione di collegamenti e-mail, ecc.) nel contesto di un tenant specificato.

Firma:

export declare class TenantManager 

Metodi

TenantManager.authForTenant()

Restituisce un'istanza TenantAwareAuth associata all'ID tenant specificato.

Firma:

authForTenant(tenantId: string): TenantAwareAuth;

Parametri

Ritorna:

TenantAwareAuth

L'istanza TenantAwareAuth corrispondente a questo identificatore del tenant.

TenantManager.createTenant()

Crea un nuovo inquilino. Quando si creano nuovi tenant, i tenant che utilizzano fatturazione e quota separate richiederanno un proprio progetto e dovranno essere definiti come full_service .

Firma:

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

Parametri

Ritorna:

Promessa< Inquilino >

Una promessa mantenuta con la configurazione del tenant corrispondente al tenant appena creato.

TenantManager.deleteTenant()

Elimina un tenant esistente.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

Una promessa vuota mantenuta una volta cancellato l'inquilino.

TenantManager.getTenant()

Ottiene la configurazione del tenant corrispondente a un determinato tenantId .

Firma:

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

Parametri

Ritorna:

Promessa< Inquilino >

Una promessa mantenuta con la configurazione del tenant al tenantId fornito .

TenantManager.listTenants()

Recupera un elenco di tenant (solo batch singolo) con una dimensione di maxResults a partire dall'offset specificato da pageToken . Viene utilizzato per recuperare tutti gli inquilini di un progetto specificato in batch.

Firma:

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

Parametri

Ritorna:

Promessa< ListaTenantsResult >

Una promessa che si risolve con un batch di tenant scaricati e il token della pagina successiva.

TenantManager.updateTenant()

Aggiorna una configurazione del tenant esistente.

Firma:

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

Parametri

Ritorna:

Promessa< Inquilino >

Una promessa mantenuta con l'aggiornamento dei dati del tenant.