TenantManager class

Definiert den Mandantenmanager, der zur Verwaltung mandantenbezogener Vorgänge verwendet wird. Das beinhaltet:

  • Die Möglichkeit, Mandanten für das zugrunde liegende Projekt zu erstellen, zu aktualisieren, aufzulisten, abzurufen und zu löschen.
  • Abrufen einer TenantAwareAuth Instanz zum Ausführen von Auth-bezogenen Vorgängen (Benutzerverwaltung, Anbieterkonfigurationsverwaltung, Token-Überprüfung, E-Mail-Link-Generierung usw.) im Kontext eines angegebenen Mandanten.

Unterschrift:

export declare class TenantManager

Methoden

Methode Modifikatoren Beschreibung
authForTenant(tenantId) Gibt eine TenantAwareAuth -Instanz zurück, die an die angegebene Mandanten-ID gebunden ist.
createTenant(tenantOptions) Erstellt einen neuen Mandanten. Beim Erstellen neuer Mandanten benötigen Mandanten, die separate Abrechnung und Kontingent verwenden, ein eigenes Projekt und müssen als full_service definiert werden.
deleteTenant(tenantId) Löscht einen vorhandenen Mandanten.
getTenant(tenantId) Ruft die Mandantenkonfiguration für den Mandanten ab, der einer bestimmten tenantId entspricht.
listTenants(maxResults, pageToken) Ruft eine Liste von Mandanten (nur Einzelbatch) mit einer Größe von maxResults ab, beginnend mit dem durch pageToken angegebenen Offset. Dies wird verwendet, um alle Mandanten eines bestimmten Projekts stapelweise abzurufen.
updateTenant(TenantId, TenantOptions) Aktualisiert eine vorhandene Mandantenkonfiguration.

TenantManager.authForTenant()

Gibt eine TenantAwareAuth -Instanz zurück, die an die angegebene Mandanten-ID gebunden ist.

Unterschrift:

authForTenant(tenantId: string): TenantAwareAuth;

Parameter

Parameter Typ Beschreibung
Mieter-ID Zeichenfolge Die Mandanten-ID, deren TenantAwareAuth Instanz zurückgegeben werden soll.

Kehrt zurück:

TenantAwareAuth

Die TenantAwareAuth Instanz, die dieser Mandanten-ID entspricht.

TenantManager.createTenant()

Erstellt einen neuen Mandanten. Beim Erstellen neuer Mandanten benötigen Mandanten, die separate Abrechnung und Kontingent verwenden, ein eigenes Projekt und müssen als full_service definiert werden .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Mieteroptionen CreateTenantRequest Die Eigenschaften, die für die neu zu erstellende Mandantenkonfiguration festgelegt werden sollen.

Kehrt zurück:

Versprechen< Mieter >

Ein Versprechen, das mit der Mandantenkonfiguration erfüllt wird, die dem neu erstellten Mandanten entspricht.

TenantManager.deleteTenant()

Löscht einen vorhandenen Mandanten.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Mieter-ID Zeichenfolge Die tenantId , die dem zu löschenden Mandanten entspricht.

Kehrt zurück:

Versprechen<void>

Ein leeres Versprechen, das erfüllt wird, sobald der Mieter gelöscht wurde.

TenantManager.getTenant()

Ruft die Mandantenkonfiguration für den Mandanten ab, der einer bestimmten tenantId entspricht .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Mieter-ID Zeichenfolge Die Mandantenkennung, die dem Mandanten entspricht, dessen Daten abgerufen werden sollen.

Kehrt zurück:

Versprechen< Mieter >

Ein Versprechen, das mit der Mandantenkonfiguration an die bereitgestellte tenantId erfüllt wird .

TenantManager.listTenants()

Ruft eine Liste von Mandanten (nur Einzelbatch) mit einer Größe von maxResults ab, beginnend mit dem durch pageToken angegebenen Offset . Dies wird verwendet, um alle Mandanten eines bestimmten Projekts stapelweise abzurufen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
maxResults Nummer Die Seitengröße, 1000, wenn nicht definiert. Dies ist auch die maximal zulässige Grenze.
pageToken Zeichenfolge Das Token für die nächste Seite. Wenn nicht angegeben, werden die beginnenden Mandanten ohne Offset zurückgegeben.

Kehrt zurück:

Versprechen< ListTenantsResult >

Ein Versprechen, das mit einem Stapel heruntergeladener Mandanten und dem Token für die nächste Seite aufgelöst wird.

TenantManager.updateTenant()

Aktualisiert eine vorhandene Mandantenkonfiguration.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Mieter-ID Zeichenfolge Die tenantId , die dem zu löschenden Mandanten entspricht.
Mieteroptionen UpdateTenantRequest Die Eigenschaften, die für den bereitgestellten Mandanten aktualisiert werden sollen.

Kehrt zurück:

Versprechen< Mieter >

Ein Versprechen, das mit der Aktualisierung der Mieterdaten eingelöst wird.