Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.admin.client.resource;
import org.keycloak.representations.idm.GroupRepresentation;
import jakarta.ws.rs.*;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.util.List;
import java.util.Map;
/**
* @author Bill Burke
* @version $Revision: 1 $
*/
public interface GroupsResource {
/**
* Get all groups.
* @return A list containing all groups.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
List groups();
/**
* Get groups by pagination params.
* @param first index of the first element (pagination offset).
* @param max the maximum number of results.
* @return A list containing the slice of all groups.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
List groups(@QueryParam("first") Integer first, @QueryParam("max") Integer max);
/**
* Get groups by pagination params.
* @param search A {@code String} representing either an exact or partial group name.
* @param first index of the first element (pagination offset).
* @param max the maximum number of results.
* @return A list containing the slice of all groups.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
List groups(@QueryParam("search") String search,
@QueryParam("first") Integer first,
@QueryParam("max") Integer max);
/**
* Get groups by pagination params.
* @param search A {@code String} representing either an exact or partial group name.
* @param first index of the first element (pagination offset).
* @param max the maximum number of results.
* @param briefRepresentation if {@code true}, each returned group representation will only contain basic information
* (id, name, path, and parentId). If {@code false}, the complete representations of the groups
* are returned (including role mappings and attributes).
* @return A list containing the slice of all groups.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
List groups(@QueryParam("search") String search,
@QueryParam("first") Integer first,
@QueryParam("max") Integer max,
@QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation);
/**
* Get groups by pagination params.
* @param search A {@code String} representing either an exact or partial group name.
* @param exact if {@code true}, the groups will be searched using exact match for the {@code search} param. If false,
* * the method returns all groups that partially match the specified name.
* @param first index of the first element (pagination offset).
* @param max the maximum number of results.
* @param briefRepresentation if {@code true}, each returned group representation will only contain basic information
* (id, name, path, and parentId). If {@code false}, the complete representations of the groups
* are returned (including role mappings and attributes).
* @return A list containing the slice of all groups.
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
List groups(@QueryParam("search") String search,
@QueryParam("exact") Boolean exact,
@QueryParam("first") Integer first,
@QueryParam("max") Integer max,
@QueryParam("briefRepresentation") @DefaultValue("true") boolean briefRepresentation);
/**
* Counts all groups.
* @return A map containing key "count" with number of groups as value.
*/
@GET
@Path("count")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
Map count();
/**
* Counts groups by name search.
* @param search max number of occurrences
* @return A map containing key "count" with number of groups as value which matching with search.
*/
@GET
@Path("count")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
Map count(@QueryParam("search") String search);
/**
* Counts groups by name search.
* @param onlyTopGroups true or false for filter only top level groups count
* @return A map containing key "count" with number of top level groups.
*/
@GET
@Path("count")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
Map count(@QueryParam("top") @DefaultValue("true") boolean onlyTopGroups);
/**
* create or add a top level realm groupSet or create child. This will update the group and set the parent if it exists. Create it and set the parent
* if the group doesn't exist.
*
* @param rep
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
Response add(GroupRepresentation rep);
@Path("{id}")
GroupResource group(@PathParam("id") String id);
@GET
@Produces(MediaType.APPLICATION_JSON)
List query(@QueryParam("q") String searchQuery);
@GET
@Produces(MediaType.APPLICATION_JSON)
List query(@QueryParam("q") String searchQuery, @QueryParam("populateHierarchy") boolean populateHierarchy);
@GET
@Produces(MediaType.APPLICATION_JSON)
List query(@QueryParam("q") String searchQuery,
@QueryParam("populateHierarchy") boolean populateHierarchy, @QueryParam("first") Integer first,
@QueryParam("max") Integer max, @QueryParam("briefRepresentation") boolean briefRepresentation);
}
