Define el administrador de inquilinos que se usa 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 de
TenantAwareAuth
para ejecutar operaciones relacionadas con Auth (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 |
---|---|---|
authForTenant(inquilinoId) | Devuelve una instancia de TenantAwareAuth vinculada al ID de inquilino dado. | |
createTenant(tenantOptions) | Crea un nuevo inquilino. Al crear nuevos inquilinos, los inquilinos que usan facturación y cuota separadas requerirán su propio proyecto y deben definirse como full_service . | |
deleteTenant(tenantId) | Elimina un inquilino existente. | |
getTenant(tenantId) | Obtiene la configuración de arrendatario correspondiente a un tenantId determinado. | |
listTenants(maxResults, pageToken) | Recupera una lista de inquilinos (solo un lote) con un tamaño de maxResults a partir del desplazamiento especificado por pageToken . Esto se usa para recuperar todos los inquilinos de un proyecto específico en lotes. | |
updateTenant(inquilinoId, inquilinoOpciones) | Actualiza una configuración de arrendatario existente. |
TenantManager.authForTenant()
Devuelve una instancia de TenantAwareAuth
vinculada al ID de inquilino dado.
Firma:
authForTenant(tenantId: string): TenantAwareAuth;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
inquilinoId | cuerda | El ID de arrendatario cuya instancia de TenantAwareAuth se va a devolver. |
Devoluciones:
La instancia de TenantAwareAuth
correspondiente a este identificador de arrendatario.
TenantManager.createTenant()
Crea un nuevo inquilino. Al crear nuevos inquilinos, los inquilinos que usan facturación y cuota separadas requerirán su propio proyecto y deben definirse como full_service
.
Firma:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
inquilinoOpciones | CreateTenantRequest | Las propiedades que se establecerán en la nueva configuración de arrendatario que se creará. |
Devoluciones:
Promesa< Inquilino >
Una promesa cumplida con la configuración del arrendatario correspondiente al arrendatario recién creado.
TenantManager.deleteTenant()
Elimina un inquilino existente.
Firma:
deleteTenant(tenantId: string): Promise<void>;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
inquilinoId | cuerda | tenantId correspondiente al arrendatario que se va a eliminar. |
Devoluciones:
Promesa <vacío>
Una promesa vacía cumplida una vez que se ha eliminado el inquilino.
TenantManager.getTenant()
Obtiene la configuración de arrendatario para el arrendatario correspondiente a un identificador de tenantId
dado. .
Firma:
getTenant(tenantId: string): Promise<Tenant>;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
inquilinoId | cuerda | El identificador de arrendatario correspondiente al arrendatario cuyos datos se van a recuperar. |
Devoluciones:
Promesa< Inquilino >
Una promesa cumplida con la configuración del arrendatario para el identificador de tenantId
proporcionado. .
TenantManager.listTenants()
Recupera una lista de inquilinos (solo un lote) con un tamaño de maxResults
a partir del desplazamiento especificado por pageToken
. Esto se usa para recuperar todos los inquilinos de un proyecto específico en lotes.
Firma:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
maxResultados | número | El tamaño de página, 1000 si no está definido. Este es también el límite máximo permitido. |
token de página | cuerda | El token de la página siguiente. Si no se especifica, devuelve los inquilinos que comienzan sin compensación. |
Devoluciones:
Promise< ListTenantsResult >
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 arrendatario existente.
Firma:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
Parámetros
Parámetro | Escribe | Descripción |
---|---|---|
inquilinoId | cuerda | tenantId correspondiente al arrendatario que se va a eliminar. |
inquilinoOpciones | UpdateTenantRequest | Las propiedades que se actualizarán en el arrendatario proporcionado. |
Devoluciones:
Promesa< Inquilino >
Una promesa cumplida con la actualización de los datos de los inquilinos.