接口文档

# 请求头说明

| 参数名 | 是否必须 | 示例值 | 说明 |
| --- | --- | --- | --- |
| Authorization | 是 | Bearer {access_token} | 用于认证的访问令牌 |
| Content-Type | 是 | application/json | 请求体的格式为 JSON |
| Accept | 否 | application/json | 返回数据期望格式为 JSON（可选） |

# 获取管理员token
请求方式: POST （其中一种方法）
请求地址: /realms/{realm}/protocol/openid-connect/token
接口说明: 获取访问 API 所需的 Token。
•	请求参数:
{realm}: 领域名称
grant_type: password（固定值）
client_id: admin-cli（或你自定义的 client）
client_secret: xxxxxxx (凭证中的客户端密钥)
username: 管理员用户名
password: 管理员密码
•	返回参数:
access_token: 访问接口所需的 token
expires_in: token 有效时间（秒）

# 用户管理
## 用户列表
请求方式: GET
请求地址: /admin/realms/{realm}/users
接口说明: 获取 realm 中所有用户，可分页查询。
参数说明： {realm} 是领域的名称
•	请求参数:
first: 起始索引（可选）
max: 最大返回数量（可选）
username: 按用户名过滤（可选）
•	返回参数:
[{id, username, email, attributes}]: 返回用户列表

```json
[
    {
        "id": "48e04677-3d74-49f0-9c40-e3a480682f7d",
        "createdTimestamp": 1744871075538,
        "username": "admin",
        "enabled": true,
        "totp": false,
        "emailVerified": false,
        "firstName": "张",
        "lastName": "无极",
        "disableableCredentialTypes": [],
        "requiredActions": [],
        "notBefore": 0,
        "access": {
            "manageGroupMembership": true,
            "view": true,
            "mapRoles": true,
            "impersonate": true,
            "manage": true
        }
    },
    {
        "id": "d343e923-e81d-4745-8104-9de4ebcfb023",
        "createdTimestamp": 1745559222223,
        "username": "qwerty",
        "enabled": true,
        "totp": false,
        "emailVerified": false,
        "firstName": "简",
        "lastName": "单",
        "email": "1928300760@163.com",
        "disableableCredentialTypes": [],
        "requiredActions": [],
        "notBefore": 0,
        "access": {
            "manageGroupMembership": true,
            "view": true,
            "mapRoles": true,
            "impersonate": true,
            "manage": true
        }
    }
]
```

## 用户新增
请求方式: POST
请求地址: /admin/realms/{realm}/users
接口说明: 在指定 realm 中创建用户。
•	请求参数:
username: 用户名
enabled: 是否启用用户（true/false）
firstName: 名字
lastName: 姓氏
email: 邮箱
attributes: {'department': '部门', 'position': '岗位'}
•	返回参数:
status: 201 表示创建成功；409 表示用户名冲突

```json
{
  "username": "user3",
  "email": "user3@example.com",
  "enabled": true,
  "emailVerified": false, //
  "firstName": "John", //姓
  "lastName": "Doe", //名
  "credentials": [
    {
      "type": "password",
      "value": "TempPass123", //密码
      "temporary": true // 导入后需首次登录修改密码
    }
  ],
  "groups": [ // 用户所属群组路径
    "/群组1/群组3"
  ],
  "attributes": { // 自定义属性
    "department": "IT",
    "phone": "123-456-7890"
  }
}
```
## 用户删除
请求方式: DELETE
请求地址: /admin/realms/{realm}/users/{user-id}
接口说明: 根据用户 ID 删除用户。
•	请求参数:
user-id: 用户的 ID（可通过获取用户接口获取）
realm: 领域名称
•	返回参数:
status: 204 表示删除成功

## 用户信息更新
请求方式 PUT
请求地址：/admin/realms/{realm}/users/{user-id}
接口说明： 根据用户的 ID 更新用户信息
•	请求参数
realms：领域名称
user-id: 用户的 ID（可通过获取用户接口获取)
•	返回参数:
status: 204 表示更新成功

#组织管理
## 组织列表
请求方式 GET
请求地址  /admin/realms/{realm}/groups
接口说明： 查询当前领域的组织信息
•	请求参数

search: 按名称模糊搜索
first: 分页起始索引
max: 返回最大条目数

## 组织下对应用户
请求方式：GET
请求地址：/admin/realms/{realm}/groups/{group-id}/members
接口说明： 根据组织的id,查询组织下对应的用户
•	请求参数
realm: 领域名称
group-id: 组织对应的id(可通过列表进行查询)
Authorization: Bearer {token}

返回参数
`[
   
    {
        "id": "",
        "createdTimestamp": 1745282804407,
        "username": "",
        "enabled": true,
        "totp": false,
        "emailVerified": false,
        "firstName": "",
        "lastName": "",
        "attributes": {
           
        },
        "disableableCredentialTypes": [],
        "requiredActions": [
            "D"
        ],
        "notBefore": 0
    }
    
]`

#领域角色
## 领域角色列表
请求方式 GET
请求地址 /admin/realms/{realm}/roles
接口说明： 查询当前领域的角色信息
•	请求参数
search: 按名称模糊搜索
first: 分页起始索引
max: 返回最大条目数
返回参数