TenantManager class

Define el administrador de usuarios que se usa para ayudar a administrar las operaciones relacionadas con el usuario. Incluye lo siguiente:

  • La capacidad de crear, actualizar, enumerar, obtener y borrar usuarios del proyecto subyacente.
  • Obtener una instancia de TenantAwareAuth para ejecutar operaciones relacionadas con Auth (administración de usuarios, administración de configuración del proveedor, verificación de tokens, generación de vínculos de correo electrónico, etc.) en el contexto de un usuario especificado

Firma:

export declare class TenantManager

Métodos

Método Teclas modificadoras Descripción
authForTenant(nombre_de_usuario) Muestra una instancia de TenantAwareAuth vinculada al ID de usuario determinado.
createTenant(nombredeusuario) Crea un usuario nuevo. Cuando se crean usuarios nuevos, aquellos que usan una facturación y cuotas por separado requerirán su propio proyecto y se deben definir como full_service.
deleteTenant(customerId) Borra un usuario existente.
getTenant(IDdelusuario) Obtiene la configuración de la instancia correspondiente a un tenantId determinado.
listTenants(maxResults, pageToken) Recupera una lista de usuarios (solo un lote único) con un tamaño de maxResults a partir del desplazamiento que especifica pageToken. Se usa para recuperar todas las instancias de un proyecto específico por lotes.
updateTenant(tenantId, tenantOptions) Actualiza la configuración de un usuario existente.

TenantManager.authForTenant()

Muestra una instancia de TenantAwareAuth vinculada al ID de usuario determinado.

Firma:

authForTenant(tenantId: string): TenantAwareAuth;

Parámetros

Parámetro Tipo Descripción
tenantId string El ID del usuario cuya instancia de TenantAwareAuth se debe mostrar.

Muestra:

TenantAwareAuth

La instancia de TenantAwareAuth correspondiente a este identificador de usuario.

TenantManager.createTenant()

Crea un usuario nuevo. Cuando se crean usuarios nuevos, aquellos que usan una facturación y cuotas por separado requerirán su propio proyecto y se deben definir como full_service.

Firma:

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

Parámetros

Parámetro Tipo Descripción
Opciones de usuario CreateTenantRequest. Las propiedades que se establecerán en la nueva configuración del usuario que se creará.

Muestra:

Promesa<Usuario>

Una promesa que se cumple con la configuración de usuario correspondiente al usuario recién creado.

TenantManager.deleteTenant()

Borra un usuario existente.

Firma:

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

Parámetros

Parámetro Tipo Descripción
tenantId string El tenantId que corresponde a la instancia que se borrará.

Muestra:

Promesa<void>

Una promesa vacía que se cumple una vez que se borra el usuario.

TenantManager.getTenant()

Obtiene la configuración de la instancia correspondiente a un tenantId determinado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
tenantId string Es el identificador que corresponde a la instancia cuyos datos se recuperarán.

Muestra:

Promesa<Usuario>

Una promesa que se cumple con la configuración del usuario para el tenantId proporcionado.

TenantManager.listTenants()

Recupera una lista de usuarios (solo un lote único) con un tamaño de maxResults a partir del desplazamiento que especifica pageToken. Se usa para recuperar todas las instancias de un proyecto específico por lotes.

Firma:

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

Parámetros

Parámetro Tipo Descripción
maxResults número Es el tamaño de la página, 1,000 si no está definido. Este también es el límite máximo permitido.
pageToken string El token de la página siguiente. Si no se especifica, muestra instancias que comienzan sin ningún desplazamiento.

Muestra:

Promesa<ListTenantsResult>

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

TenantManager.updateTenant()

Actualiza la configuración de un usuario existente.

Firma:

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

Parámetros

Parámetro Tipo Descripción
tenantId string El tenantId correspondiente a la instancia que se borrará.
Opciones de usuario UpdateTenantRequest Las propiedades que se actualizarán en el usuario proporcionado.

Muestra:

Promesa<Usuario>

Una promesa que se cumple con la actualización de los datos del usuario.