On this page

Function
Constraints
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ User Management/ Disabling a User

Disabling a User

Updated on 2024-12-30 GMT+08:00

View PDF

Function

This API is used to disable a user.

Constraints

null

URI

PUT /api/v2/tenant/users/{user_id}/disable

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	User ID.

Request Parameters

**Table 2** Request header 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

**Table 3** Response body parameters
Parameter	Type	Description
user_id	String	User ID.

Status code: 400

**Table 4** Response body parameters
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.

Parent topic: User Management

Previous topic: Enabling a User

Next topic: Changing a User Password

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot