Open Health Sync
Releasesv0.1.0
Api referenceEndpointsAdmin

Revoke a tenant's API key (instance admin)

DELETE
/v1/admin/tenants/{tenant_id}/keys/{key_id}

Every call with the key is refused from now on. Revoking a revoked key changes nothing. The key making the call cannot be revoked (409). A key of another tenant is a 404. Recorded as key.revoke in the caller's audit log and in the tenant's.

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
key_id*string
Formatuuid

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

Revoked.

curl -X DELETE 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/keys/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer ohs_sk_...'
Empty
Edit on GitHub