retrieve - User Module Reference

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

This method retrieves a user by its ID.

Example

A simple example that retrieves a {type name} by its ID:

{
  example - code
}

To specify relations that should be retrieved:

{
  example - code
}

Parameters

idstringRequired

The ID of the retrieve.

configFindConfig<UserDTO>

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

sharedContextContext

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

Returns

PromisePromise<UserDTO>Required

The retrieved user.