Package org.keycloak.admin.client.resource

Interface OrganizationMemberResource

public interface OrganizationMemberResource

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    delete()
     
    List<org.keycloak.representations.idm.OrganizationRepresentation>
    getOrganizations()
    Returns the organizations associated with the user
    List<org.keycloak.representations.idm.OrganizationRepresentation>
    getOrganizations(boolean briefRepresentation)
    Returns the organizations associated with the user
    List<org.keycloak.representations.idm.GroupRepresentation>
    groups(Integer firstResult, Integer maxResults, boolean briefRepresentation)
    Returns the organization group memberships for this member
    List<org.keycloak.representations.idm.GroupRepresentation>
    groups(Integer firstResult, Integer maxResults, String search, boolean briefRepresentation)
    Returns the organization group memberships for this member
    org.keycloak.representations.idm.MemberRepresentation
    toRepresentation()
     

  • Method Details

    • toRepresentation

      @GET @Produces("application/json") org.keycloak.representations.idm.MemberRepresentation toRepresentation()

    • delete

      @DELETE jakarta.ws.rs.core.Response delete()

    • getOrganizations

      @Path("organizations") @GET @Produces("application/json") List<org.keycloak.representations.idm.OrganizationRepresentation> getOrganizations()
      Returns the organizations associated with the user
      Returns:
      the organizations associated with the user
      Since:
      Keycloak server 26

    • getOrganizations

      @Path("organizations") @GET @Produces("application/json") List<org.keycloak.representations.idm.OrganizationRepresentation> getOrganizations(@QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation)
      Returns the organizations associated with the user
      Parameters:
      briefRepresentation - if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default. Parameter supported since Keycloak 26.3. It is assumed to be false for the older Keycloak server versions.
      Returns:
      the organizations associated with the user
      Since:
      Keycloak server 26

    • groups

      @Path("groups") @GET @Produces("application/json") List<org.keycloak.representations.idm.GroupRepresentation> groups(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults, @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation)
      Returns the organization group memberships for this member
      Parameters:
      firstResult - the position of the first result to be processed (pagination offset)
      maxResults - the maximum number of results to be returned
      briefRepresentation - if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default.
      Returns:
      the organization groups the member belongs to
      Since:
      Keycloak server 26.6.0

    • groups

      @Path("groups") @GET @Produces("application/json") List<org.keycloak.representations.idm.GroupRepresentation> groups(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults, @QueryParam("search") String search, @QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation)
      Returns the organization group memberships for this member
      Parameters:
      firstResult - the position of the first result to be processed (pagination offset)
      maxResults - the maximum number of results to be returned
      search - a case-insensitive search string to filter groups by name. If null or blank, no filtering is applied.
      briefRepresentation - if false, return the full representation. Otherwise, only the basic fields are returned. It is true by default.
      Returns:
      the organization groups the member belongs to
      Since:
      Keycloak server 26.6.0