upstream/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-06-08 16:42:13 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 16

Clarify credentials field availability in GET /admin/realms/{realm}/users documentation

Browse source 
Closes #46972

Signed-off-by: Hisanobu Okuda <hisanobu.okuda@gmail.com>
This commit is contained in:
Hisanobu Okuda 2026-03-24 07:48:17 +09:00 committed by GitHub
parent 7f29bc7956
commit ce672801af
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
services/src/main/java/org/keycloak/services/resources/admin/UsersResource.java
View file

@ -272,7 +272,8 @@ public class UsersResource {
@APIResponse(responseCode = "403", description = "Forbidden")
})
@Tag(name = KeycloakOpenAPI.Admin.Tags.USERS)
@Operation(summary = "Get users Returns a stream of users, filtered according to query parameters.")
@Operation(summary = "Get users Returns a stream of users, filtered according to query parameters.",
description = "Returns a stream of users. Note that the 'credentials' field in the returned UserRepresentation objects is typically not populated for performance reasons. If specific credential metadata is required, use the dedicated 'GET /admin/realms/{realm}/users/{user-id}/credentials' endpoint.")
public Stream<UserRepresentation> getUsers(
@Parameter(description = "A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use *foo* for infix search and \"foo\" for exact search.") @QueryParam("search") String search,
@Parameter(description = "A String contained in lastName, or the complete lastName, if param \"exact\" is true") @QueryParam("lastName") String last,