Package org.activiti.cloud.services.identity.keycloak.client

Interface KeycloakClient

@FeignClient(value="keycloak",
             url="${keycloak.auth-server-url}/admin/realms/${keycloak.realm}/",
             configuration=org.activiti.cloud.security.feign.configuration.ClientCredentialsAuthConfiguration.class)
public interface KeycloakClient

Method Summary

Modifier and Type	Method	Description
List<KeycloakRoleMapping>	addGroupClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
List<KeycloakRoleMapping>	addUserClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
List<KeycloakRoleMapping>	getClientRoles(String id)
List<KeycloakRoleMapping>	getGroupClientRoleMapping(String id, String client)
List<KeycloakRoleMapping>	getGroupRoleMapping(String id)
List<KeycloakGroup>	getGroupsClientRoleMapping(String id, String roleName)
List<KeycloakRoleMapping>	getUserClientRoleMapping(String id, String client)
List<KeycloakGroup>	getUserGroups(String userId)
List<KeycloakRoleMapping>	getUserRoleMapping(String id)
List<KeycloakUser>	getUsersByGroupId(String groupId)
List<KeycloakUser>	getUsersClientRoleMapping(String id, String roleName)
List<KeycloakClientRepresentation>	searchClients(String clientId, Integer first, Integer max)
List<KeycloakGroup>	searchGroups(String search, Integer first, Integer max)
List<KeycloakUser>	searchUsers(String search, Integer first, Integer max)

Method Detail

searchUsers

@RequestMapping(method=GET,
                value="/users")
List<KeycloakUser> searchUsers(@RequestParam("search")
                               String search,
                               @RequestParam("first")
                               Integer first,
                               @RequestParam("max")
                               Integer max)

getUserRoleMapping

@RequestMapping(method=GET,
                value="/users/{id}/role-mappings/realm/composite")
@Cacheable("userRoleMapping")
List<KeycloakRoleMapping> getUserRoleMapping(@PathVariable("id")
                                             String id)

getUserGroups

@RequestMapping(method=GET,
                value="/users/{id}/groups")
@Cacheable("userGroups")
List<KeycloakGroup> getUserGroups(@PathVariable("id")
                                  String userId)

searchGroups

@RequestMapping(method=GET,
                value="/groups")
List<KeycloakGroup> searchGroups(@RequestParam("search")
                                 String search,
                                 @RequestParam("first")
                                 Integer first,
                                 @RequestParam("max")
                                 Integer max)

getGroupRoleMapping

@RequestMapping(method=GET,
                value="/groups/{id}/role-mappings/realm/composite")
@Cacheable("groupRoleMapping")
List<KeycloakRoleMapping> getGroupRoleMapping(@PathVariable("id")
                                              String id)

searchClients

@RequestMapping(method=GET,
                value="/clients")
List<KeycloakClientRepresentation> searchClients(@RequestParam(value="clientId",required=false)
                                                 String clientId,
                                                 @RequestParam("first")
                                                 Integer first,
                                                 @RequestParam("max")
                                                 Integer max)

getUserClientRoleMapping

@RequestMapping(method=GET,
                value="/users/{id}/role-mappings/clients/{client}/composite")
List<KeycloakRoleMapping> getUserClientRoleMapping(@PathVariable("id")
                                                   String id,
                                                   @PathVariable("client")
                                                   String client)

getGroupClientRoleMapping

@RequestMapping(method=GET,
                value="/groups/{id}/role-mappings/clients/{client}/composite")
List<KeycloakRoleMapping> getGroupClientRoleMapping(@PathVariable("id")
                                                    String id,
                                                    @PathVariable("client")
                                                    String client)

getClientRoles

@RequestMapping(method=GET,
                value="clients/{id}/roles")
List<KeycloakRoleMapping> getClientRoles(@PathVariable("id")
                                         String id)

addUserClientRoleMapping

@RequestMapping(method=POST,
                value="/users/{id}/role-mappings/clients/{client}")
List<KeycloakRoleMapping> addUserClientRoleMapping(@PathVariable("id")
                                                   String id,
                                                   @PathVariable("client")
                                                   String client,
                                                   @RequestBody
                                                   List<KeycloakRoleMapping> roles)

addGroupClientRoleMapping

@RequestMapping(method=POST,
                value="/groups/{id}/role-mappings/clients/{client}")
List<KeycloakRoleMapping> addGroupClientRoleMapping(@PathVariable("id")
                                                    String id,
                                                    @PathVariable("client")
                                                    String client,
                                                    @RequestBody
                                                    List<KeycloakRoleMapping> roles)

getUsersClientRoleMapping

@RequestMapping(method=GET,
                value="clients/{id}/roles/{role-name}/users")
List<KeycloakUser> getUsersClientRoleMapping(@PathVariable("id")
                                             String id,
                                             @PathVariable("role-name")
                                             String roleName)

getGroupsClientRoleMapping

@RequestMapping(method=GET,
                value="clients/{id}/roles/{role-name}/groups")
List<KeycloakGroup> getGroupsClientRoleMapping(@PathVariable("id")
                                               String id,
                                               @PathVariable("role-name")
                                               String roleName)

getUsersByGroupId

@RequestMapping(method=GET,
                value="/groups/{groupId}/members")
List<KeycloakUser> getUsersByGroupId(@PathVariable("groupId")
                                     String groupId)