listAndCountAuthIdentities - Auth Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a paginated list of auth identities along with the total count of available auth identities satisfying the provided filters.

Example#

To retrieve a list of auth identities using their IDs:

Code
1const [authIdentities, count] =2  await authModuleService.listAndCountAuthIdentities({3    id: ["authusr_123", "authusr_321"],4  })

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

Code
1const [authIdentities, count] =2  await authModuleService.listAndCountAuthIdentities(3    {4      id: ["authusr_123", "authusr_321"],5    },6    {7      take: 20,8      skip: 2,9    }10  )

Parameters#

filtersFilterableAuthIdentityPropsOptional

The filters to apply on the retrieved auth identities.

configFindConfig<AuthIdentityDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[AuthIdentityDTO[], number]>

The list of auth identities along with their total count.