StandaloneAPI referenceClients

Delete a user

Delete a user, through Ovok's Signals gateway.

Delete a user

MethodPath
DELETE/v1/signals/api/user/{id}
  • Sandbox: available
  • Staging: available
  • Production: unknown

Revokes the credential at once and drops its undelivered webhook events.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_webhooks:delete. Project admins have every capability; client applications get no admin bypass.
  • Only subscribers are deleted through ovok.
  • It can reach any patient of your project without naming one, so it is for callers that reach every patient: project admins, manager or submitter apps, and anyone whose Patient access has no criteria.

Request

Path parameters

NameTypeRequiredDescription
idstringYes—

Responses

StatusMeaning
200Deleted: the id of the user that is gone.
400A path value holds a character ovok does not send to Signals, such as a raw : or +. Percent-encode it. The query carries a raw #, or more than 200 parameters.
401Your ovok access token, or your client id and secret, are missing or invalid.
403ovok refused the call: you lack a capability this route needs, or your session has no project, or the user is not a subscriber, or your access covers only some patients.
404No such client in this tenant.
409Your project has no Signals tenant of its own (SIGNALS_TENANT_NOT_OWN), or it is moving to another one.
429Too many requests. Retry after the seconds in Retry-After.
500ovok hit an unexpected fault, such as your project having no Signals submitter.
502Signals answered with something ovok couldn't use, or refused ovok's own credential.
503Signals is unavailable. Retry after the seconds in Retry-After.
504Signals did not answer in time.

Example

curl --request DELETE 'https://api.sandbox.ovok.com/v1/signals/api/user/:id' \
  --user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"

Last updated on

On this page