TenantManager class

Définit le gestionnaire de locataires utilisé pour aider à gérer les opérations liées aux locataires. Ceci comprend:

• La possibilité de créer, mettre à jour, répertorier, obtenir et supprimer des locataires pour le projet sous-jacent.
• Obtention d'une instance TenantAwareAuth pour exécuter des opérations liées à l'authentification (gestion des utilisateurs, gestion de la configuration du fournisseur, vérification des jetons, génération de liens de courrier électronique, etc.) dans le contexte d'un locataire spécifié.

Signature:

export declare class TenantManager 

Méthodes

TenantManager.authForTenant()

Renvoie une instance TenantAwareAuth liée à l’ID de locataire donné.

Signature:

authForTenant(tenantId: string): TenantAwareAuth;

Paramètres

Retour:

TenantAwareAuth

Instance TenantAwareAuth correspondant à cet identifiant de locataire.

TenantManager.createTenant()

Crée un nouveau locataire. Lors de la création de nouveaux locataires, les locataires qui utilisent une facturation et un quota séparés nécessiteront leur propre projet et doivent être définis comme full_service .

Signature:

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

Paramètres

Retour:

Promesse < Locataire >

Une promesse tenue avec la configuration du locataire correspondant au locataire nouvellement créé.

TenantManager.deleteTenant()

Supprime un locataire existant.

Signature:

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

Paramètres

Retour:

Promesse<vide>

Une promesse vide de sens remplie une fois le locataire supprimé.

TenantManager.getTenant()

Obtient la configuration du locataire correspondant à un tenantId donné .

Signature:

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

Paramètres

Retour:

Promesse < Locataire >

Une promesse remplie avec la configuration du locataire pour le tenantId fourni .

TenantManager.listTenants()

Récupère une liste de locataires (un seul lot uniquement) avec une taille de maxResults à partir du décalage spécifié par pageToken . Ceci est utilisé pour récupérer tous les locataires d'un projet spécifié par lots.

Signature:

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

Paramètres

Retour:

Promesse< ListTenantsResult >

Une promesse qui se résout avec un lot de locataires téléchargés et le jeton de la page suivante.

TenantManager.updateTenant()

Met à jour une configuration de locataire existante.

Signature:

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

Paramètres

Retour:

Promesse < Locataire >

Une promesse tenue avec la mise à jour des données des locataires.