Releasesv0.1.0
Users

Erase a user's data from one provider

DELETE
/v1/users/{id}/data/{provider}

Erases everything the user holds from one provider without touching any connection: the route for device providers (apple_health, health_connect), which have no connection, and for a provider already disconnected. A background job deletes every record, raw file and sync record of this user and provider; the user and their other providers stay. The answer is 202 with the job_id to poll at GET /v1/deletions/{job_id}; asking again while it runs returns the same job. Until it is done, uploads of that provider for the user are refused (409). A provider the user is still connected to is a 409: use DELETE /v1/users/{id}/connections/{provider}?delete_data=true. A provider unknown to this build is a 404.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
provider*string

Connector slug, see GET /v1/providers.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

Erasure accepted.

application/json
  1. response
job_id*string
Formatuuid
curl -X DELETE 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/withings' \  -H 'Authorization: Bearer ohs_sk_...'
{  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"}
Edit on GitHub