UserService · UserService_DeleteUser
Access
Requires the named account's owner or an instance administrator. Field-specific and lifecycle restrictions still apply; owner access does not allow changing administrator-only fields.
Leave spaces before deleting
The account must first leave all non-invitation space memberships. Deletion removes its memos, attachments, tokens/settings, identities, notifications and other owned records. force does not bypass that prerequisite. This is a permanent account-content deletion, and a storage-cleanup error can occur after the account is already deleted.
Successful response
This operation has no resource to return. The Rust REST transport serializes protobuf Empty as HTTP 200 with JSON {}. The empty success-schema area in the generated contract is intentional, not missing request instructions.
Request
DeleteUser deletes a user.
/api/v1/users/{user}Parameters
| Name / location | Type / requirement | Description |
|---|---|---|
userpath | string Required | The user id. |
forcequery | boolean Not marked required in OpenAPI | Optional. If set to true, the user will be deleted even if they have associated data. |
Request body
No request body is declared.
Responses
200 · OK
default · Default error response
application/json · Status
Complete operation definition
All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.
Open JSON definition
{
"tags": [
"UserService"
],
"description": "DeleteUser deletes a user.",
"operationId": "UserService_DeleteUser",
"parameters": [
{
"name": "user",
"in": "path",
"description": "The user id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Optional. If set to true, the user will be deleted even if they have associated data.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}