Interface OrganizationMemberResource


public interface OrganizationMemberResource
  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
     
    List<org.keycloak.representations.idm.OrganizationRepresentation>
    Returns the organizations associated with the user
    List<org.keycloak.representations.idm.OrganizationRepresentation>
    getOrganizations(boolean briefRepresentation)
    Returns the organizations associated with the user
    org.keycloak.representations.idm.MemberRepresentation
     
  • 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