list - Auth Module Reference

This documentation provides a reference to the list method. This belongs to the Auth Module.

This method retrieves a paginated list of auth users based on optional filters and configuration.

Example

To retrieve a list of auth users using their IDs:

const authUsers = await authModuleService.list({
  id: ["authusr_123", "authusr_321"],
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const authUsers = await authModuleService.list(
  {
    id: ["authusr_123", "authusr_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableAuthUserProps

The filters to apply on the retrieved auth users.

configFindConfig<AuthUserDTO>

The configurations determining how the auth user is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a auth user.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<AuthUserDTO[]>Required

The list of auth users.