Skip to content
Navigation

Delete a user from every store

Erase a user: identity, auth row, threads, checkpoints, queued work, memory graph and overlay, owned resources, uploaded files, caches.

user_id is the Truememory UUID (the user_id your other calls return). Service callers may address the user with X-On-Behalf-Of or X-External-User-Id instead, as long as it matches the path.

Answers 202 as soon as the user is marked deleted and their deletion workflow is started. From the mark on, any request with the user's token or naming them in a subject header answers 410 USER_DELETED. The workflow (one per user) removes the identity and every store on the maintenance lane, normally within seconds, retrying a store that fails. Poll GET /users/{user_id}/deletion or pass callback_url. A second call for a deletion that completed returns completed; otherwise it starts the workflow again, which is a no-op while one is in flight and a retry when the last one ended failed.

?dry_run=true returns row counts per store and the memory scopes that would be removed, and writes nothing.

DELETE
https://truememory-api.mvstg.com/users/{user_id}
View as Markdown

Authorization

  • HTTPBearerHTTPrequired

Path parameters

  • user_idstringrequired

Query parameters

  • dry_runoptionalboolean
    default: false

Header parameters

  • X-On-Behalf-Ofoptional

    One of the following:

    • string
    • null
  • X-External-User-Idoptional

    One of the following:

    • string
    • null
  • X-App-Idoptional

    One of the following:

    • string
    • null

Request bodyJSON

One of the following:

  • UserDeletionRequest
    • reasonoptional

      One of the following:

      • string
      • null
    • callback_urloptional

      One of the following:

      • string
      • null
    • include_linkedoptionalboolean
      default: false
  • null

Returns

202

Successful Response

JSON

One of the following:

  • UserDeletionStatus
    • user_idstringrequired
    • statusacceptedorrunningorcompletedorfailedrequired
    • requested_atstringrequired
      format: date-time
    • completed_atoptional

      One of the following:

      • string
      • null
  • UserDeletionDryRun
    • user_idstringrequired
    • rowsmap ofintegerrequired

      Row count per Postgres table.

    • memory_scopesarray ofstringrequired

      Memory graph scopes the user owns.

    • graph_nodesintegerrequired

      Nodes in the user's own graphs.

    • overlay_scopesarray ofstringrequired

      Vector-overlay scopes that still hold rows.

    • member_recordsintegerrequired

      The user's records stamped into shared graphs.

    • dry_runoptionalboolean
      default: true

422

Validation Error
JSON
  • detailoptionalarray ofobject
    • locarray ofrequired

      One of the following:

      • string
      • integer
    • msgstringrequired
    • typestringrequired
    • inputoptionalunknown
    • ctxoptionalobject

Type to search…

↑↓ navigate↵ selectEsc close