Sort/order in user admin REST API

bilak · March 26, 2020, 6:09pm

Hello,
is it somehow possible to sort the result of user query?

Like if I want to search with following query
{{keycloakUrl}}/admin/realms/{{keycloakRealm}}/users?search=luk
Am I able to provide sort option - order by firstName,ASC for example?

Thanks

zonaut · March 26, 2020, 10:08pm

There doesn’t seem to be an option to do that.

github.com

keycloak/keycloak/blob/master/services/src/main/java/org/keycloak/services/resources/admin/UsersResource.java#L199


 * @param first
 * @param email
 * @param username
 * @param first Pagination offset
 * @param maxResults Maximum results size (defaults to 100)
 * @return
 */
@GET
@NoCache
@Produces(MediaType.APPLICATION_JSON)
public List<UserRepresentation> getUsers(@QueryParam("search") String search,
                                         @QueryParam("lastName") String last,
                                         @QueryParam("firstName") String first,
                                         @QueryParam("email") String email,
                                         @QueryParam("username") String username,
                                         @QueryParam("first") Integer firstResult,
                                         @QueryParam("max") Integer maxResults,
                                         @QueryParam("briefRepresentation") Boolean briefRepresentation) {
    UserPermissionEvaluator userPermissionEvaluator = auth.users();


    userPermissionEvaluator.requireQuery();

github.com

keycloak/keycloak/blob/master/model/jpa/src/main/java/org/keycloak/models/jpa/JpaUserProvider.java#L915




    subquery1.where(subs.toArray(new Predicate[subs.size()]));


    subPredicates.add(builder.exists(subquery1));


    subquery.where(subPredicates.toArray(new Predicate[subPredicates.size()]));


    predicates.add(builder.exists(subquery));
}


queryBuilder.where(predicates.toArray(new Predicate[predicates.size()])).orderBy(builder.asc(root.get(UserModel.USERNAME)));


TypedQuery<UserEntity> query = em.createQuery(queryBuilder);


if (firstResult != -1) {
    query.setFirstResult(firstResult);
}


if (maxResults != -1) {
    query.setMaxResults(maxResults);
}

Topic		Replies	Views
Get User api returns users we didn't created Getting advice	0	274	July 24, 2022
UsersResource.search(search, start, max) doesn't work Getting advice admin-rest	5	2045	October 3, 2021
Ability to search via attribute in Admin REST API Tips and tricks	0	871	June 18, 2020
Admin API - get all users with custom attributes	2	3660	April 4, 2022
403 Forbidden - Accessing Keycloak APIs Getting advice	3	1954	March 9, 2022

Sort/order in user admin REST API

Related Topics