一篇学会java调用Keycloak Admin-cli User和Group Api

Keycloak admin-cli Api 可以方便的用于管理用户，组，角色等数据。本博客总结了一下如何管理用户和组的信息，学习的最初来源keycloak官方文档。

XXXResource

从官方文档中可以发现，有几组这样的类 UserResource/UsersResource, RoleResource/RolesResource, GroupResource/GroupsResource等. 这些类在keycloak admin-cli api 扮演着controller的角色，因此通过它们可以对相应的资源进行CRUD的操作。以UserResource/UsersResource为例, UserResouce 用于某一具体user的操作,而UsersResource用于user集合的操作，例如根据id修改user的信息，就需要使用UserResource,而获取一组user则需要使用UsersResource.

XXXRepresentation

与XXXResource一样, 存在这样一些类UserRepresentation, RoleRepresentation, GroupRepresentation等. 它们扮演着model的角色，通过它们可以将我们需要的信息呈现出来。

CRUD operation

CRUD之前， keycloak admin-cli 必须配进整个环境中，可以之前的博文

User CRUD

在CRUD之前，必须先通过keycloak的实例拿到user 的controller，也就是所谓的UsersResource. 注意： keycloak的实例可以以bean方式注入到spring窗口中，可以参考此文

UsersResource usersResource = keycloak.realm(realm).users();

Create User

//创建user model
UserRepresentation userRepresentation = new UserRepresentation();
userRepresentation.setUsername("po");
userRepresentation.setEnabled(true);
//使用controller(UsersResource) 调用创建user的api
Response response = usersResource.create(userRepresentation )

Retrieve user

keycloak admin-cli api 提供了多种方式获取user,这里仅提供一种，详细的可以参考其官方文档

//获取 10 users
List<UserRepresentation> userList = usersResource.list(0, 10);
// 过滤得到状态为enabled用户
userList.stream().filter(user -> user.isEnabled().booleanValue());

Update User

// 先根据user id 从user 集合中获取此user的user resource
UserResource userResource = usersResource.get(id);
// 获取此user的model
UserRepresentation userPresentation = userResource.toRepresentation();
// 设置新值
userPresentation.setLastName(“lastName”);
// 调用 update api
userResource.update(userPresentation);

Delete User

这里需要注意一下，因为是从某一集合中删除user,所以不需要将user拿出来对其操作，故直接使用UsersResource即可。

Response response = usersResource.delete(userId);

Group CRUD

与User的操作一样，在操作group前，group的controller(GroupResource/GroupsResource)也需要通过keycloak的实例获取。
注意： keycloak的实例可以以bean方式注入到spring窗口中，可以参考此文

GroupsResource groupsResource = keycloak.realm(realm).