Delete a user¶

Remove the specified user’s workspace membership. After deletion, the user can no longer access the current workspace.

HTTP
POST $CLOUDSIGMA_API_BASE/user/delete

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First select the user and confirm that the user should be removed from the current workspace.

Request parameters¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/user/delete" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "user-001"
  }'

Parameter description

Parameter	Type	Required	Description
`id`	string	Yes	User ID.

Successful response¶

On success, the user’s workspace membership has been deleted and data is null.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": null
}

Field details

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data`	null	Always `null` on success.

Error response¶

Response example

JSON
{
  "code": "INVALID_ARGUMENT",
  "msg": "请求参数无效",
  "data": null
}

Field details

Field	Type	Description
`code`	string	Error code.
`msg`	string	Error message.
`data`	null	—

Last updated on Sep 15, 2026