mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-02-05 14:58:58 -06:00
Code Issues Packages Projects Releases Wiki Activity

Javadoc of Keycloak-admin-client for Keycloak server 26.5 release

Browse Source 
closes #45217

Signed-off-by: mposolda <mposolda@gmail.com>
This commit is contained in:
mposolda
2026-01-07 15:02:12 +01:00
committed by Marek Posolda
parent 99828b4cc4
commit bcc8f684f2
4 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/IdentityProvidersResource.java
View File

@@ -45,6 +45,20 @@ public interface IdentityProvidersResource {
@Produces(MediaType.APPLICATION_JSON)
List<IdentityProviderRepresentation> findAll();
/**
* Get the paginated list of identity providers, filtered according to the specified parameters.
*
* @param type Type of identity provider. See the class org.keycloak.models.IdentityProviderType for the available values. When parameter is omitted, there is no filtering by type.
* This parameter is available since Keycloak 26.5.0
* @param capability Capability of identity provider. Used just if type is omitted. See the class org.keycloak.models.IdentityProviderCapability for the available values. When parameter is omitted, there is no filtering by capability.
* This parameter is available since Keycloak 26.5.0
* @param search Filter to search specific providers by name. Search can be prefixed (name*), contains (*name*) or exact (\"name\"). Default prefixed.
* @param briefRepresentation Boolean which defines whether brief representations are returned (default: false).
* If true, only basic data like ID, alias, providerId and enabled status will be returned in the result
* @param firstResult Pagination offset
* @param maxResults Maximum results size (defaults to 100)
* @return The list of providers.
*/
@GET
@Path("instances")
@Produces(MediaType.APPLICATION_JSON)

5
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/OrganizationInvitationsResource.java
View File

@@ -31,6 +31,11 @@ import jakarta.ws.rs.core.Response;
import org.keycloak.representations.idm.OrganizationInvitationRepresentation;
/**
* Managing organization invitations.
*
* @since Keycloak server 26.5.0
*/
public interface OrganizationInvitationsResource {
/**

4
integration/admin-client/src/main/java/org/keycloak/admin/client/resource/OrganizationResource.java
View File

@@ -44,6 +44,10 @@ public interface OrganizationResource {
@Path("members")
OrganizationMembersResource members();
/**
* @since Keycloak server 26.5.0.
* @return {@link OrganizationInvitationsResource} to manage organization invitations
*/
@Path("invitations")
OrganizationInvitationsResource invitations();

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

@@ -19,7 +19,7 @@ import com.fasterxml.jackson.jakarta.rs.yaml.YAMLMediaTypes;
/**
* @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
* This endpoint including all the child endpoints require feature {@link org.keycloak.common.Profile.Feature#WORKFLOWS} to be enabled. Note that feature is preview in 26.5.0 and there might be
* backwards incompatible changes in the future versions of admin-client and Keycloak server<p>
*/
public interface WorkflowsResource {