Api referenceEndpointsAdmin
Status of a deletion (instance admin, one tenant)
GET
GET /v1/deletions/{job_id} (getDeletion) for the tenant of tenant_id, read with an
instance admin key: the same parameters and the same answer as the tenant's own key
gets. Recorded in the caller's audit log and, actor admin, in the tenant's.
See docs/admin-api.md.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
tenant_id*stringThe id of a tenant; any other value is a 404.
Format
uuidjob_id*stringThe job_id returned by DELETE /v1/users/{id}, DELETE /v1/users/{id}/data/{provider}
or DELETE /v1/users/{id}/connections/{provider}?delete_data=true.
Format
uuidThe deletion job.
application/json- response
job_id*stringFormat
uuiduser_id*stringFormat
uuidprovider*|The provider whose data the job erases; null when it deletes the whole user.
status*stringdone 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*stringFormat
date-timefinished_at*|Format
date-timecurl -X GET 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/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"}