User API Enhancements - include details and limit

The ability to display the list of users on Capella is basic functionality that users will expect. The 3.0 version of user REST endpoint returns list of all user names in the system. There are no details included with user. To fetch user details, a separate call needs to be issued for each user in the list. Also, there is no way to limit the number of results.

In production deployments. the resulting set can be very large and transferring the complete result set of users from SGW across the CP can be expensive. Also the round trip cost of a separate call for each user is expensive.

The enhancement is to support the following enhancements to REST API

• An optional query param that will allow users to optionally include user details. The API needs to remain backwards compatible with 3.0
  • { "name":"<string>", "admin_channels":[ "<string>", "<string>" ], "admin_roles":[ "<string>", "<string>" ], "all_channels":[ ], "email":"<string>", "disabled":"<boolean>", "roles":[] }

     

• An optional limit parameter that will limit the size of the result set. The returned list must be ordered by time of user creation (with newest at top)
• A parameter to omit the GUEST user from the resultset

Future : Pagination and additional filtering logic t