Releasesv0.1.0
Users

Status of a deletion

GET
/v1/deletions/{job_id}

Poll until status is done: the user's raw files and rows are gone (with provider set, only those of that provider). The job is kept after the user is deleted. Another tenant's job is a 404.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

job_id*string

The job_id returned by DELETE /v1/users/{id}, DELETE /v1/users/{id}/data/{provider} or DELETE /v1/users/{id}/connections/{provider}?delete_data=true.

Formatuuid

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The deletion job.

application/json
  1. response
job_id*string
Formatuuid
user_id*string
Formatuuid
provider*|

The provider whose data the job erases; null when it deletes the whole user.

status*string

done once every raw file and row of the user (or of the user and provider) is deleted.

Value in"pending""running""done""failed"
created_at*string
Formatdate-time
finished_at*|
Formatdate-time
curl -X GET 'http://localhost:8080/v1/deletions/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer ohs_sk_...'
{  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "provider": "string",  "status": "pending",  "created_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}
Edit on GitHub