Function listOrgUsersForOrganizationHandler

  • listOrgUsersForOrganizationHandler(paginationConfiguration, service, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get organization users handler

    Parameters

    • paginationConfiguration: PaginationConfigurations

      injected pagination configuration

    • service: Pick<OrgUserDataService, "setLogger" | "listPaginatedOrganizationUsers" | "expandOrganizationUsers">

      injected service use to handle the organization related operations

      • listPaginatedOrganizationUsers
      • expandOrganizationUsers
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query]. Note:

      • params is required
      • params.orgId is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 OK

    • data: organization user list with pagination

    Description

    This handler will get organization users by applying the following steps in sequence:

    1. Parse paginated list query (util.parsePaginatedListQuery)

    2. Get organization user list (service.readPagedOrganizationUsers)

    3. Return organization user list

    Remarks

    This endpoint only support paginate by offset and limit. Expand user information by adding $expand=user to query. Will trigger logger warn if user not found.

    Throws

    400 NBError Bad Request

    • error when parse paginated list query
    • This endpoint only support paginate by offset and limit

    Throws

    500 NBError Internal Server Error

    • error when getting organization user list

Settings

Member Visibility

Theme

Generated using TypeDoc