Deleting a Workspace User
Function
This API is used to delete a user from a workspace.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/{workspace_id}/delete-users
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID |
| workspace_id | Yes | String | Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. This parameter is mandatory for token authentication. Call the "Obtaining the User Token" API of IAM to obtain the value of X-Subject-Token in the response header. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| user_ids | Yes | Object | User group list, which can be obtained using the API for querying the workspace user information list |
Response Parameters
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Returned error information. |
| error_code | String | Returned error code. |
Example Requests
{
"user_ids" : [ "2d032145d82546b5b83cd7a6fd7d0afc" ]
} Example Responses
Status code: 200
The user is deleted from the workspace.
{
"message" : null,
"is_success" : true
} Status code: 400
Bad request.
{
"error_code" : "DAYU.4402",
"error_msg" : "The operation failed, detail msg {0}."
} Status code: 500
Internal server error.
{
"error_code" : "DAYU.3531",
"error_msg" : "Internal server error: {0}"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The user is deleted from the workspace. |
| 400 | Bad request. |
| 500 | Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.