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

Interface KeycloakClient

public interface KeycloakClient

Method Summary

Modifier and Type	Method	Description
List<KeycloakRoleMapping>	addGroupClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
void	addRealmLevelUserRoleMapping(String id, List<KeycloakRoleMapping> roles)
List<KeycloakRoleMapping>	addUserClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
Integer	countAllUsers()
feign.Response	createClient(KeycloakClientRepresentation keycloakClientRepresentation)
KeycloakRoleMapping	createRoleRepresentationForClient(String id, KeycloakRoleMapping keycloakRoleMapping)
void	deleteClient(String id)
List<KeycloakClientRepresentation>	findByClientId(String clientId)
KeycloakCredentialRepresentation	generateNewClientSecret(KeycloakCredentialRequestRepresentation requestRepresentation, String id)
KeycloakMappingsRepresentation	getAllGroupRoleMapping(String id)
List<KeycloakGroup>	getAllGroups()
List<KeycloakUser>	getAllUsers(Integer max)
KeycloakClientRepresentation	getClientById(String id)
List<KeycloakRoleMapping>	getClientLevelRoleMappingAvailable(String id, String clientId)
List<KeycloakRoleMapping>	getClientRoles(String id)
KeycloakCredentialRepresentation	getClientSecretById(String id)
KeycloakGroup	getGroupById(String id)
KeycloakGroup	getGroupByPath(String path)
List<KeycloakRoleMapping>	getGroupClientRoleMapping(String id, String client)
List<KeycloakRoleMapping>	getGroupRoleMapping(String id)
List<KeycloakGroup>	getGroupsClientRoleMapping(String id, String roleName)
KeycloakRoleMapping	getRoleRepresentationForClient(String id, String roleName)
KeycloakUser	getServiceAccountUserOfClient(String id)
KeycloakUser	getUserById(String id)
List<KeycloakRoleMapping>	getUserClientRoleMapping(String id, String client)
List<KeycloakGroup>	getUserGroups(String userId)
List<KeycloakRoleMapping>	getUserRoleMapping(String id)
List<KeycloakRoleMapping>	getUserRoleMappingAvailable(String id)
KeycloakMappingsRepresentation	getUserRoles(String userId)
default List<KeycloakUser>	getUsersByGroupId(String groupId)
List<KeycloakUser>	getUsersByGroupId(String groupId, Integer first, Integer max)
default List<KeycloakUser>	getUsersClientRoleMapping(String id, String roleName)
List<KeycloakUser>	getUsersClientRoleMapping(String id, String roleName, Integer first, Integer max)
List<KeycloakRoleMapping>	removeGroupClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
List<KeycloakRoleMapping>	removeUserClientRoleMapping(String id, String client, List<KeycloakRoleMapping> roles)
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)
List<KeycloakUser>	searchUsersByUsername(String username)
void	updateClient(String id, KeycloakClientRepresentation keycloakClientRepresentation)

Method Details

searchUsers

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

searchUsersByUsername

@RequestMapping(method=GET,
                value="/users")
List<KeycloakUser> searchUsersByUsername(@RequestParam("username")
 String username)

getUserRoleMapping

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

getUserRoleMappingAvailable

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

addRealmLevelUserRoleMapping

@RequestMapping(method=POST,
                value="/users/{id}/role-mappings/realm")
void addRealmLevelUserRoleMapping(@PathVariable("id")
 String id,
 List<KeycloakRoleMapping> roles)

getUserGroups

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

getUserRoles

@RequestMapping(method=GET,
                value="/users/{id}/role-mappings")
KeycloakMappingsRepresentation getUserRoles(@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)

getAllGroupRoleMapping

@RequestMapping(method=GET,
                value="/groups/{id}/role-mappings")
KeycloakMappingsRepresentation getAllGroupRoleMapping(@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)

removeUserClientRoleMapping

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

removeGroupClientRoleMapping

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

getUsersClientRoleMapping

default List<KeycloakUser> getUsersClientRoleMapping(String id,
 String roleName)

getUsersClientRoleMapping

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

getServiceAccountUserOfClient

@RequestMapping(method=GET,
                value="clients/{id}/service-account-user")
KeycloakUser getServiceAccountUserOfClient(@PathVariable("id")
 String id)

getGroupsClientRoleMapping

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

getRoleRepresentationForClient

@RequestMapping(method=GET,
                value="clients/{id}/roles/{role-name}")
KeycloakRoleMapping getRoleRepresentationForClient(@PathVariable("id")
 String id,
 @PathVariable("role-name")
 String roleName)

createRoleRepresentationForClient

@RequestMapping(method=POST,
                value="clients/{id}/roles")
KeycloakRoleMapping createRoleRepresentationForClient(@PathVariable("id")
 String id,
 @RequestBody
 KeycloakRoleMapping keycloakRoleMapping)

getUsersByGroupId

default List<KeycloakUser> getUsersByGroupId(String groupId)

getUsersByGroupId

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

getGroupById

@RequestMapping(method=GET,
                value="/groups/{id}")
KeycloakGroup getGroupById(@PathVariable("id")
 String id)

getAllGroups

@RequestMapping(method=GET,
                value="/groups")
List<KeycloakGroup> getAllGroups()

getAllUsers

@RequestMapping(method=GET,
                value="/users")
List<KeycloakUser> getAllUsers(@RequestParam(name="max",required=false,defaultValue="100")
 Integer max)

countAllUsers

@RequestMapping(method=GET,
                value="/users/count")
Integer countAllUsers()

getUserById

@RequestMapping(method=GET,
                value="/users/{id}")
KeycloakUser getUserById(@PathVariable("id")
 String id)

getGroupByPath

@RequestMapping(method=GET,
                value="/group-by-path/{path}")
KeycloakGroup getGroupByPath(@PathVariable("path")
 String path)

findByClientId

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

getClientById

@RequestMapping(method=GET,
                value="/clients/{id}")
KeycloakClientRepresentation getClientById(@PathVariable("id")
 String id)

deleteClient

@RequestMapping(method=DELETE,
                value="/clients/{id}")
void deleteClient(@PathVariable("id")
 String id)

createClient

@RequestMapping(method=POST,
                value="/clients")
feign.Response createClient(@RequestBody
 KeycloakClientRepresentation keycloakClientRepresentation)

updateClient

@RequestMapping(method=PUT,
                value="/clients/{id}")
void updateClient(@PathVariable("id")
 String id,
 @RequestBody
 KeycloakClientRepresentation keycloakClientRepresentation)

generateNewClientSecret

@RequestMapping(method=POST,
                value="/clients/{id}/client-secret")
KeycloakCredentialRepresentation generateNewClientSecret(@RequestBody
 KeycloakCredentialRequestRepresentation requestRepresentation,
 @PathVariable("id")
 String id)

getClientSecretById

@RequestMapping(method=GET,
                value="/clients/{id}/client-secret")
KeycloakCredentialRepresentation getClientSecretById(@PathVariable("id")
 String id)

getClientLevelRoleMappingAvailable

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