Get one user
- 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.
AuthorizationBearer <JWT>id*stringThe client's Signals id.
The user.
application/json- response
id*stringtenantId*stringclientId*stringname*stringwebhookUrl*stringWhere alert webhooks are POSTed.
custom?stringv1's custom: an opaque string sent back on every webhook in the x-actimi-custom header. Absent when unset.
hasWebhookSecret*booleanWhether v1's webhookSecret is set (event schema 1); a schema-2 subscriber signs with its Standard Webhooks secret instead. Never returned: it is write-only.
events*array<string>Event patterns this client receives, e.g. alert.*.
eventSchema*numberWhich names and bodies its webhooks use. 1: v1's, alert.trigger with refire and resolved flags. 2: one type per state change (alert.triggered, alert.refired, alert.resolved, …) in the Standard Webhooks envelope {type, timestamp, sequence, data}, the alert carrying its version.
12reach*stringA subscriber's patients: attached, those attached to it, as v1's; all, every patient of the tenant, those enrolled later included.
"attached""all"signingSecret?stringOn a new event-schema-2 subscriber's create answer only: its first Standard Webhooks signing secret, returned this once. Rotate it with POST /api/subscriber/{id}/webhook/rotate-secret.
createdAt*stringdate-timeupdatedAt*stringdate-time_id*stringThe same value as id.
role*stringThe role in v1's lowercase.
tenant*stringThe tenant id, under v1's name.
curl -X GET 'https://api.sandbox.ovok.com/v1/signals/api/user/string'{ "id": "string", "tenantId": "string", "clientId": "string", "name": "string", "webhookUrl": "string", "custom": "string", "hasWebhookSecret": true, "events": [ "string" ], "eventSchema": 1, "reach": "attached", "signingSecret": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "_id": "string", "role": "string", "tenant": "string"}Create a user POST
Mints an API client. `clientId` and `secret` are the Basic credential, chosen by the caller and never returned. `role` may be v1's lowercase. A SUBSCRIBER needs `webhookUrl` and at least one event. It is on `eventSchema` 2 unless the body says 1: on 2 its first Standard Webhooks signing secret is returned this once as `signingSecret`; on 1 it needs `webhookSecret` (v1 called it `secret`). `reach` is `attached` (default: the patients attached to it, as v1's) or `all` (every patient of the tenant, those enrolled later included). ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_webhooks:update`, `signals_events:read`. Project admins have every capability; client applications get no admin bypass. - Only subscribers are created through ovok, on event schema 2. ovok generates their id and Signals login, which they never use, and Signals generates the webhook signing secret. - 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.
Update a user POST
Sets the name, webhook target, signing secret, events, event schema, reach or credential secret. ### Through ovok - **Who can call it:** Manager apps, and users whose access policy grants the capabilities. - **Capabilities, all required:** `signals_webhooks:update`, `signals_events:read`. Project admins have every capability; client applications get no admin bypass. - Only subscribers are changed through ovok. Their `role`, `eventSchema`, `clientId`, `secret` and `webhookSecret` can't be sent. - 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.