Customer Identity (CIAM)
Disable User
# Request Description
PUT https://{your_domain}/api/v2/tenant/users/{user_id}/disable
# Request Headers
| Parameter | Name | Required | Type | Description |
|---|---|---|---|---|
| Authorization | Authorization | Yes | String | Format: Bearer {access_token} |
| Content-Type | Content-Type | Yes | String | Fixed value: application/json; charset=utf-8 |
# Request Example
PUT https://{your_domain}/api/v2/tenant/users/20220126153857263-A04D-60E0D446C/disable
# Request Parameters
| Parameter | Name | Required | Type | Description |
|---|---|---|---|---|
| user_id | User ID | Yes | String | The ID of the user to disable |
# Return Example
Correct Example
HTTP/1.1 200 OK
Content-Type: application/json
{
"user_id": "20201028102749564-9082-DC8CD2722"
}
Error Example
HTTP/1.1 400 Bad Request
{
"error_msg": "User not found",
"error_code": "IDAAS.TENANT.USER.0001"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# Return Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| user_id | User user_id | String |
# Error Codes
| Status Code | Error Code | Error Message | Handling Measure |
|---|---|---|---|
| 400 | IDAAS.TENANT.USER.0001 | User not found | Please check if the corresponding user exists |
| User not found |