External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Update javadoc of java admin-client for Keycloak 26.4

Browse Source 
closes #42468

Signed-off-by: mposolda <mposolda@gmail.com>
This commit is contained in:
mposolda 2025-09-24 17:52:56 +02:00 committed by Marek Posolda
parent 389314a65e
commit bb34b80174
3 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
integration/admin-client/src/main/java/org/keycloak/admin/client/KeycloakBuilder.java
View File

@ -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 * @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 * @return admin client builder
*/ */
public KeycloakBuilder useDPoP(boolean useDPoP) { public KeycloakBuilder useDPoP(boolean useDPoP) {

2
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/UsersResource.java
View File

@ -382,6 +382,8 @@ public interface UsersResource {
* @param emailVerified emailVerified field of a user * @param emailVerified emailVerified field of a user
* @param username username field of a user * @param username username field of a user
* @param enabled Boolean representing if user is enabled or not * @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 * @return number of users matching the given filters
*/ */
@Path("count") @Path("count")

6
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/WorkflowsResource.java
View File

@ -13,6 +13,12 @@ import jakarta.ws.rs.core.Response;
import org.keycloak.representations.workflows.WorkflowRepresentation; import org.keycloak.representations.workflows.WorkflowRepresentation;
import org.keycloak.representations.workflows.WorkflowSetRepresentation; import org.keycloak.representations.workflows.WorkflowSetRepresentation;
/**
* @since Keycloak server 26.4.0. All the child endpoints are also available since that version<p>
*
* 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<p>
*/
public interface WorkflowsResource { public interface WorkflowsResource {
@POST @POST