From bb34b801741195ddd24f5a72e317e276584d370f Mon Sep 17 00:00:00 2001 From: mposolda Date: Wed, 24 Sep 2025 17:52:56 +0200 Subject: [PATCH] Update javadoc of java admin-client for Keycloak 26.4 closes #42468 Signed-off-by: mposolda --- .../java/org/keycloak/admin/client/KeycloakBuilder.java | 3 ++- .../org/keycloak/admin/client/resource/UsersResource.java | 2 ++ .../keycloak/admin/client/resource/WorkflowsResource.java | 6 ++++++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/integration/admin-client/src/main/java/org/keycloak/admin/client/KeycloakBuilder.java b/integration/admin-client/src/main/java/org/keycloak/admin/client/KeycloakBuilder.java index 036aa01d2a9..0c6d802e449 100644 --- a/integration/admin-client/src/main/java/org/keycloak/admin/client/KeycloakBuilder.java +++ b/integration/admin-client/src/main/java/org/keycloak/admin/client/KeycloakBuilder.java @@ -126,7 +126,8 @@ public class KeycloakBuilder { /** * @param useDPoP If true, then admin-client will add DPoP proofs to the token-requests and to the admin REST API requests. DPoP feature must be - * enabled on Keycloak server side to work properly. It is false by default. + * enabled on Keycloak server side to work properly. It is false by default. Parameter is supposed to be used with Keycloak server 26.4.0 or later as + * earlier versions did not support DPoP requests for admin REST API * @return admin client builder */ public KeycloakBuilder useDPoP(boolean useDPoP) { diff --git a/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/UsersResource.java b/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/UsersResource.java index 75c7dc5027f..fc2ea5230a9 100644 --- a/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/UsersResource.java +++ b/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/UsersResource.java @@ -382,6 +382,8 @@ public interface UsersResource { * @param emailVerified emailVerified field of a user * @param username username field of a user * @param enabled Boolean representing if user is enabled or not + * @param idpAlias The alias of an Identity Provider linked to the user. Parameter supported since Keycloak server 26.4.0 + * @param idpUserId The userId at an Identity Provider linked to the user. Parameter supported since Keycloak server 26.4.0 * @return number of users matching the given filters */ @Path("count") diff --git a/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowsResource.java b/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowsResource.java index 0fda6d22067..4e9c7934ed3 100644 --- a/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowsResource.java +++ b/integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowsResource.java @@ -13,6 +13,12 @@ import jakarta.ws.rs.core.Response; import org.keycloak.representations.workflows.WorkflowRepresentation; import org.keycloak.representations.workflows.WorkflowSetRepresentation; +/** + * @since Keycloak server 26.4.0. All the child endpoints are also available since that version

+ * + * This endpoint including all the child endpoints require feature {@link org.keycloak.common.Profile.Feature#WORKFLOWS} to be enabled. Note that feature is experimental in 26.4.0 and there might be + * backwards incompatible changes in the future versions of admin-client and Keycloak server

+ */ public interface WorkflowsResource { @POST