Function listUsersHandler

listUsersHandler(userService, customFieldDefinitions, logger, context): Promise<adapter.AdapterHandlerResponse>
Get users handler
Parameters
- userService: UserDataService
  injected service use to handle the user related operations
  - getUsers
- customFieldDefinitions: CustomField[]
  injected custom field definitions
- logger: Logger
  injected logger used to handle the logging
- context: AdapterHandlerContext
  request context [headers, body, params, query].
Returns Promise<adapter.AdapterHandlerResponse>
200 Status OK
- data: users with pagination
Description
This handler will get users by applying the following steps in sequence:
1. Parse query parameters
2. Get users (userService.getUsers)
3. Expand user custom fields if needed
4. Normalize user response (normalizeUserResponse)
5. Return users
Throws
400 NBError Bad Request
- pagination must be set
- page size is too large, must less than MAXIMUM_PAGE_SIZE
- Defined in src/adapter/default/handlers/user/list-users.handler.ts:46

Generated using TypeDoc