员工身份(EIAM)
禁用用户
接口
# 权限
身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。
| 权限代码 | 描述 |
|---|---|
| user_all | 用户管理接口的读写权限 |
| all | 全部接口读写权限 |
# 请求说明
PUT https://{your_domain}/api/v2/tenant/users/{user_id}/disable
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| Authorization | 授权 | 是 | String | 格式：Bearer {access_token} |
| Content-Type | 内容类型 | 是 | String | 固定值：application/json; charset=utf-8 |
# 请求示例
无
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| user_id | 用户ID | 是 | String | 要禁用的用户ID |
# 返回示例
正确示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
"user_id": "20201028102749564-9082-DC8CD2722"
}
错误示例：
{
"error_msg": "用户不存在",
"error_code": "USER.0001"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| user_id | 用户user_id | String |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | USER.0001 | 用户不存在 | 请检查对应用户是否存在 |
| User does not exist |