如何使用WSO2 Charon SCIM库扩展用户Schema？

1. 定义自定义属性的Schema JSON #

先创建描述自定义属性的SCIM Schema JSON，明确属性的名称、类型、约束等信息。比如扩展员工ID和部门字段，示例如下：

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
  "id": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
  "name": "EnterpriseUser",
  "description": "Enterprise User Extension",
  "attributes": [
    {
      "name": "employeeId",
      "type": "string",
      "multiValued": false,
      "description": "Unique identifier for an employee",
      "caseExact": false,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "server"
    },
    {
      "name": "department",
      "type": "string",
      "multiValued": false,
      "description": "Department the user belongs to",
      "caseExact": false,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "none"
    }
  ]
}

2. 注册自定义Schema到Charon服务器 #

在SCIM服务器启动阶段，使用SCIMSchemaManager将自定义Schema注册到系统中。示例Java代码：

import org.wso2.charon3.core.schema.SCIMSchemaManager;
import org.wso2.charon3.core.schema.SCIMSchema;
import org.wso2.charon3.core.exceptions.CharonException;

// 加载自定义Schema JSON字符串（可从文件读取或直接定义）
String customSchemaJson = "..."; // 填入上述JSON内容
SCIMSchema customSchema = SCIMSchema.fromJson(customSchemaJson);

// 获取Schema管理器实例
SCIMSchemaManager schemaManager = SCIMSchemaManager.getInstance();
try {
    // 注册自定义Schema
    schemaManager.registerSchema(customSchema);
} catch (CharonException e) {
    // 处理注册异常
    e.printStackTrace();
}

3. 关联自定义Schema到用户资源 #

将自定义Schema的URI添加到用户资源的默认Schema列表，让用户资源能识别并处理这些自定义属性。示例代码：

import org.wso2.charon3.core.resources.User;
import java.util.ArrayList;
import java.util.List;

// 获取用户资源的默认Schema列表
List<String> userSchemas = new ArrayList<>(User.DEFAULT_SCHEMAS);
// 添加自定义Schema的URI
userSchemas.add("urn:ietf:params:scim:schemas:extension:enterprise:2.0:User");

// 更新用户资源的Schema配置
User.setDefaultSchemas(userSchemas);

4. 自定义属性处理（可选） #

如果自定义属性需要特殊逻辑（比如格式校验、数据转换），可以实现AttributeHandler接口并注册到SCIMProvider：

import org.wso2.charon3.core.attributes.AttributeHandler;
import org.wso2.charon3.core.objects.SCIMObject;
import org.wso2.charon3.core.exceptions.CharonException;

public class CustomAttributeHandler implements AttributeHandler {
    @Override
    public void handleAttribute(SCIMObject scimObject, String attributeName, Object attributeValue) throws CharonException {
        // 示例：校验employeeId格式
        if ("employeeId".equals(attributeName)) {
            String id = (String) attributeValue;
            if (!id.matches("^EMP\\d{4}$")) {
                throw new CharonException("Invalid employee ID format. Must be EMP followed by 4 digits.");
            }
        }
    }
}

// 注册处理器到SCIMProvider
import org.wso2.charon3.core.provider.SCIMProvider;

SCIMProvider scimProvider = SCIMProvider.getInstance();
scimProvider.setAttributeHandler(new CustomAttributeHandler());

5. 验证扩展效果 #

• 创建用户时，请求体中可包含自定义属性：

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ],
  "userName": "john.doe@example.com",
  "password": "Password123!",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeId": "EMP1234",
    "department": "Engineering"
  }
}

• 获取用户详情时，响应体应包含这些自定义属性，确认扩展生效。

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