StandaloneAPI referenceClients

Get one user

Get one user, through Ovok's Signals gateway.

Get one user

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

Without its secret, which is not retrievable.

Through ovok

  • Who can call it: Manager apps, and users whose access policy grants the capabilities.
  • Capabilities, all required: signals_clients:read. Project admins have every capability; client applications get no admin bypass.

Request

Path parameters

NameTypeRequiredDescription
idstringYesThe client's Signals id.

Responses

StatusMeaning
200The user.
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. From Signals: Authenticated, but the client's role does not permit this, or it is not attached to the patient.
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 GET 'https://api.sandbox.ovok.com/v1/signals/api/user/:id' \
  --user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"

Last updated on

On this page