StandaloneAPI referenceTenants

Get the caller's tenant

Get the caller's tenant, through Ovok's Signals gateway.

Get the caller's tenant

MethodPath
GET/v1/signals/api/tenant
  • Sandbox: available
  • Staging: available
  • Production: unknown

The tenant is resolved from the credential; there is no id to pass. orgSettings is its tenant-wide rule settings, {} when none were written.

Through ovok

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

Request

No parameters or body.

Responses

StatusMeaning
200The tenant, its feature switches and its rule settings.
400The 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.
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/tenant' \
  --user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"

Last updated on

On this page