listProviderIdentities - Auth Module Reference

This documentation provides a reference to the listProviderIdentities 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 provider identities based on optional filters and configuration.

Example#

To retrieve a list of provider identities using their IDs:

Code
1const providerIdentities = await authModuleService.listProviderIdentities({2  id: ["provider_123", "provider_234"],3})

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 providerIdentities = await authModuleService.listProviderIdentities(2  {3    id: ["provider_123", "provider_234"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterableProviderIdentityPropsOptional

The filters to apply on the retrieved provider identities.

configFindConfig<ProviderIdentityDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProviderIdentityDTO[]>

The list of provider identities.