Releasesv0.1.0
Api referenceEndpointsAdmin

Disconnect a provider (instance admin, one tenant)

DELETE
/v1/admin/tenants/{tenant_id}/users/{id}/connections/{provider}

DELETE /v1/users/{id}/connections/{provider} (deleteConnection) for the tenant of tenant_id, run with an instance admin key: the same body, parameters and answer as the tenant's own key gets; a Location points at the admin route. Recorded in the caller's audit log and, actor admin, in the tenant's. See docs/admin-api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

tenant_id*string

The id of a tenant; any other value is a 404.

Formatuuid
id*string
Formatuuid
provider*string

Connector slug, see GET /v1/providers.

Query Parameters

delete_data?boolean

true also erases the data the user holds from this provider.

Defaultfalse

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

Disconnected, and the erasure of the provider's data accepted.

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