Disabling a User
Function
This API is used to disable a user.
Constraints
null
URI
PUT /api/v2/tenant/users/{user_id}/disable
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_id |
Yes |
String |
User ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Authorization |
Yes |
String |
Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
User ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error details. |
Example Requests
Disable a user based on the transferred user ID.
PUT https://{domain_name}/api/v2/tenant/users/{user_id}/disable Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...
Example Responses
Status code: 200
Request successful.
{ "user_id" : "20210621095935811-5E16-6B3060..." }
Status Codes
Status Code |
Description |
---|---|
200 |
Request successful. |
400 |
Invalid parameter. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot