修海哥和满哥的博客

Keycloak 提供了 RESTful API 用于管理用户、角色、权限等信息。要修改用户的状态(例如启用或禁用用户)以及管理用户的角色分配,可以使用以下 API 接口。 ### 修改用户状态 Keycloak 中用户的启用或禁用状态可以通过更新用户属性来实现。具体 API 如下: - **API 路径**: `PUT /auth/admin/realms/{realm}/users/{userId}` - **请求体**: 更新用户的 JSON 数据,其中包含 `enabled` 字段来控制用户状态。 示例请求: ```http PUT /auth/admin/realms/myrealm/users/12345678-90ab-cdef-ghij-klmnopqrstuv HTTP/1.1 Authorization: Bearer <access_token> Content-Type: application/json { "enabled": false } ``` 此请求将用户 ID 为 `12345678-90ab-cdef-ghij-klmnopqrstuv` 的用户禁用[^1]。 ### 分配或移除用户角色 Keycloak 提供了专门的 API 来管理用户的角色分配,包括添加删除角色。 #### 添加角色到用户 - **API 路径**: `POST /auth/admin/realms/{realm}/users/{userId}/role-mappings/realm` - **请求体**: 一个包含角色名称的 JSON 数组。 示例请求: ```http POST /auth/admin/realms/myrealm/users/12345678-90ab-cdef-ghij-klmnopqrstuv/role-mappings/realm HTTP/1.1 Authorization: Bearer <access_token> Content-Type: application/json [ { "id": "role-id-1", "name": "my-role" } ] ``` 此请求将角色 `my-role` 添加到指定用户上。 #### 移除用户的角色 - **API 路径**: `DELETE /auth/admin/realms/{realm}/users/{userId}/role-mappings/realm` - **请求体**: 一个包含角色名称的 JSON 数组。 示例请求: ```http DELETE /auth/admin/realms/myrealm/users/12345678-90ab-cdef-ghij-klmnopqrstuv/role-mappings/realm HTTP/1.1 Authorization: Bearer <access_token> Content-Type: application/json [ { "id": "role-id-1", "name": "my-role" } ] ``` 此请求将角色 `my-role` 从指定用户上移除[^1]。 ### 获取用户的角色列表 - **API 路径**: `GET /auth/admin/realms/{realm}/users/{userId}/role-mappings/realm` - **响应示例**: ```json [ { "id": "role-id-1", "name": "my-role", "description": "My custom role" } ] ``` 此接口返回用户当前分配的所有角色信息。 ### 认证授权 在调用这些 API 时,需要确保请求头中包含有效的访问令牌 (`access_token`),并且该令牌所属的客户端或用户具有足够的权限来管理用户角色。通常,这需要在 Keycloak 管理控制台中为客户端或用户分配 `manage-users` `view-users` 等权限。 ### 总结 Keycloak 提供了完整的 REST API 来管理用户的状态角色分配。通过上述接口,可以轻松实现用户状态的修改以及角色的添加、删除查询操作。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值