Turn a provider off, or back on, for one tenant (instance admin)
While a provider is off for a tenant, GET /v1/providers and the connect page leave it
out for the tenant, starting a connection, the OAuth callback, uploads and self reports
answer 403, sync now answers 409, no pull is planned and a queued one ends cancelled
without reaching the provider. Connections and data are kept. The switch applies at once
in the process that answers and within 30 seconds in the others. Recorded as
tenant.provider in the caller's audit log and in the tenant's, together with the change.
tenantKeyAuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
tenant_id*stringThe id of a tenant; any other value is a 404.
uuidprovider*stringConnector slug, see GET /v1/providers.
application/json- body
enabled*booleanfalse turns the provider off for the tenant, true turns it back on.
The provider for the tenant after the change.
application/json- response
slug*stringname*stringkinds*array<>instance_status*stringThe provider's status on the instance, as GET /v1/admin/providers gives it.
"active""off""not_configured""error""built_in"enabled*booleanThe tenant's switch, true unless an instance admin turned it off.
own_keys*booleanTrue while the tenant has keys of its own for the provider
(/v1/admin/tenants/{tenant_id}/providers/{provider}/keys).
available*booleanTrue when the tenant's users can use the provider now: enabled is true and either the
tenant's own keys run, or the tenant has none and the instance runs the provider
(active or built_in).
updated_at*|The last change of the switch, null when it was never set.
date-timecurl -X PATCH 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/providers/withings' \ -H 'Authorization: Bearer ohs_sk_...' \ -H 'Content-Type: application/json' \ -d '{ "enabled": true}'{ "slug": "oura", "name": "Oura", "kinds": [ "oauth" ], "instance_status": "active", "enabled": true, "own_keys": true, "available": true, "updated_at": "2019-08-24T14:15:22Z"}