retrieveUser - User Module Reference

This documentation provides a reference to the retrieveUser method. This belongs to the User Module.

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

This method retrieves a user by its ID.

Example#

Code
const user = await userModuleService.retrieveUser("user_123")

Parameters#

idstring

The ID of the user.

configFindConfig<UserDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<UserDTO>

The retrieved user.

Was this page helpful?