Skip to content

DELETE /user/

Archive User

DELETE
/user/{user_key}

Soft-delete (archive) a user account.

Sets trash=True on the User document identified by user_key. The
account remains in the database for audit and traceability but is excluded
from active user lists. Does not revoke any outstanding tokens.

Emits: (direct transaction — no event class)

Required scope: org:user:delete

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Path Parameters

user_key*
Type
string
Required

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.