基于Keycloak User Storage SPI通过RESTful API持久化新用户

1. 自定义UserModel拦截属性设置动作 #

Keycloak在为UserModel附加属性时，会调用setSingleAttribute()或setAttribute()方法。你可以在自定义UserModel实现类中重写这些方法，收集所有属性，待关键属性齐全后触发REST API调用：

public class CustomUserModel extends AbstractUserModel {
    private Map<String, List<String>> collectedAttributes = new HashMap<>();
    private boolean isUserSaved = false;
    private final YourRestApiClient restClient;

    public CustomUserModel(RealmModel realm, YourRestApiClient restClient) {
        super(realm);
        this.restClient = restClient;
    }

    @Override
    public void setSingleAttribute(String name, String value) {
        collectedAttributes.put(name, Collections.singletonList(value));
        trySaveUser();
    }

    @Override
    public void setAttribute(String name, List<String> values) {
        collectedAttributes.put(name, values);
        trySaveUser();
    }

    private void trySaveUser() {
        // 检查是否已收集到必填属性（如username、email、password等），且未执行过保存
        if (!isUserSaved 
            && collectedAttributes.containsKey("username")
            && collectedAttributes.containsKey("email")) {
            
            // 构造包含全属性的请求体
            UserCreateRequest request = new UserCreateRequest();
            request.setUsername(getUsername());
            request.setEmail(collectedAttributes.get("email").get(0));
            // 补充其他属性...
            
            restClient.createUser(request);
            isUserSaved = true;
        }
    }
}

2. 结合事件监听器获取完整用户信息 #

在addUser方法中创建临时自定义UserModel，同时注册Keycloak事件监听器监听REGISTER事件，待用户注册流程完成（所有属性设置完毕）时，从事件中获取完整信息并调用REST API：

• 自定义UserRegistrationProvider的addUser方法，返回带临时标识的自定义UserModel
• 实现EventListenerProvider，监听REGISTER事件，从事件上下文提取完整用户属性
• 在监听器中关联临时用户标识，调用REST API完成用户创建

3. 扩展Keycloak注册流程（进阶方案） #

如果需要更强的灵活性，可扩展Keycloak的RegistrationProfile或RegistrationUserCreation认证流程：

• 自定义注册流程步骤，在用户提交表单后直接收集全量属性
• 先调用你的REST API完成用户创建，再将用户信息同步到自定义存储Provider中
• 通过Keycloak管理界面配置启用自定义注册流程

需求可行性说明 #

你的需求完全可以实现，核心是避开仅依赖addUser方法参数的限制，通过拦截属性设置时机或利用事件机制获取完整用户属性，再发起REST调用。

内容的提问来源于stack exchange，提问作者developer10