TenantManager class

Define el administrador de inquilinos utilizado para ayudar a administrar las operaciones relacionadas con los inquilinos. Esto incluye:

  • La capacidad de crear, actualizar, enumerar, obtener y eliminar inquilinos para el proyecto subyacente.
  • Obtener una instancia TenantAwareAuth para ejecutar operaciones relacionadas con la autenticación (administración de usuarios, administración de configuración de proveedores, verificación de tokens, generación de enlaces de correo electrónico, etc.) en el contexto de un inquilino específico.

Firma:

export declare class TenantManager

Métodos

Método Modificadores Descripción
autenticaciónParaInquilino(IdInquilino) Devuelve una instancia TenantAwareAuth vinculada al ID de inquilino proporcionado.
crear inquilino (opciones de inquilino) Crea un nuevo inquilino. Al crear nuevos inquilinos, los inquilinos que utilizan facturación y cuota independientes necesitarán su propio proyecto y deberán definirse como full_service .
eliminar inquilino (Id. de inquilino) Elimina un inquilino existente.
getInquilino(IdInquilino) Obtiene la configuración del inquilino correspondiente a un tenantId determinado.
listaInquilinos(maxResults, pageToken) Recupera una lista de inquilinos (solo un solo lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken . Esto se utiliza para recuperar todos los inquilinos de un proyecto específico en lotes.
actualizarInquilino(inquilinoId, inquilinoOptions) Actualiza una configuración de inquilino existente.

TenantManager.authForTenant()

Devuelve una instancia TenantAwareAuth vinculada al ID de inquilino proporcionado.

Firma:

authForTenant(tenantId: string): TenantAwareAuth;

Parámetros

Parámetro Tipo Descripción
ID de inquilino cadena El ID del inquilino cuya instancia TenantAwareAuth se va a devolver.

Devoluciones:

InquilinoAwareAuth

La instancia TenantAwareAuth correspondiente a este identificador de inquilino.

TenantManager.createTenant()

Crea un nuevo inquilino. Al crear nuevos inquilinos, los inquilinos que utilizan facturación y cuota independientes necesitarán su propio proyecto y deben definirse como full_service .

Firma:

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

Parámetros

Parámetro Tipo Descripción
opciones de inquilino Crear solicitud de inquilino Las propiedades que se establecerán en la nueva configuración del inquilino que se creará.

Devoluciones:

Promesa< Inquilino >

Una promesa cumplida con la configuración del inquilino correspondiente al inquilino recién creado.

TenantManager.deleteTenant()

Elimina un inquilino existente.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de inquilino cadena El tenantId correspondiente al inquilino que se va a eliminar.

Devoluciones:

Promesa<nulo>

Una promesa vacía cumplida una vez eliminado el inquilino.

TenantManager.getTenant()

Obtiene la configuración del inquilino correspondiente a un tenantId determinado. .

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de inquilino cadena El identificador del inquilino correspondiente al inquilino cuyos datos se van a recuperar.

Devoluciones:

Promesa< Inquilino >

Una promesa cumplida con la configuración del inquilino para el tenantId proporcionado .

TenantManager.listTenants()

Recupera una lista de inquilinos (solo un solo lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken . Esto se utiliza para recuperar todos los inquilinos de un proyecto específico en lotes.

Firma:

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

Parámetros

Parámetro Tipo Descripción
resultados máximos número El tamaño de la página, 1000 si no está definido. Este es también el límite máximo permitido.
token de página cadena El token de la página siguiente. Si no se especifica, devuelve inquilinos que comienzan sin ninguna compensación.

Devoluciones:

Promesa< ListaInquilinosResultado >

Una promesa que se resuelve con un lote de inquilinos descargados y el token de la página siguiente.

TenantManager.updateTenant()

Actualiza una configuración de inquilino existente.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de inquilino cadena El tenantId correspondiente al inquilino que se va a eliminar.
opciones de inquilino Solicitud de actualización de inquilino Las propiedades que se actualizarán en el inquilino proporcionado.

Devoluciones:

Promesa< Inquilino >

Una promesa cumplida con la actualización de los datos del inquilino.