如何通过Keycloak Rest Admin API获取用户会话笔记？

核心结论 #

GET /admin/realms/{realm}/users/{id}/sessions 接口默认不返回用户会话笔记，这是Keycloak Admin API的默认行为。

原因分析 #

Keycloak的Admin API返回的用户会话列表（SessionRepresentation）结构中，默认不包含userSessionNotes字段。你设置的会话笔记确实已保存在UserSession实体中，但该批量查询接口不会主动返回这部分数据。

验证与解决方案 #

1. 先验证会话笔记是否已正确保存 #

调用单个会话详情接口 GET /admin/realms/{realm}/user-sessions/{sessionId}，这个接口返回的完整会话信息里会包含userSessionNotes字段，你可以通过这个接口确认笔记是否被正确存储。

2. 获取批量会话笔记的可行方案 #

方案一：分两步查询

• 第一步：调用GET /admin/realms/{realm}/users/{id}/sessions获取该用户所有会话的id列表。
• 第二步：遍历每个会话ID，调用GET /admin/realms/{realm}/user-sessions/{sessionId}获取对应会话的笔记内容。

方案二：扩展Keycloak Admin API（进阶）

如果你需要直接从批量接口返回笔记，需要自定义扩展Keycloak：

• 实现UserResource的扩展，修改getUserSessions方法，在构建SessionRepresentation时添加userSessionNotes字段。
• 或者通过Keycloak的SPI机制，自定义会话数据的序列化逻辑，让批量接口包含笔记信息。不过这种方式需要对Keycloak源码有一定了解，且升级Keycloak时需要同步维护扩展。

额外检查点 #

• 确保调用Admin API的账号拥有足够权限：需要view-users或manage-users角色权限，否则可能无法获取完整的会话数据。
• 确认代码中设置笔记的逻辑正确：你使用context.getAuthenticationSession().setUserSessionNote("key", "value")是正确的，该方法确实会将笔记绑定到UserSession上。

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