OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
SlimSlim/User

Delete user

  • Sandbox: available
  • Staging: available
  • Production: unknown
DELETE
/v1/slim/user/{profileType}/{profileId}

Removes a practitioner from a project: deletes their membership and practitioner profile, and their user account when this was their last membership. Use it to offboard a team member.

Auth: Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant Practitioner:delete (a project admin who holds no access policy skips this check). Scope: The practitioner's project must be the caller's project (from the token) or a direct child of it.

Behaviour

  • profileType must be Practitioner and profileId a UUID.
  • The membership, the practitioner and, when it has no other membership, the user are deleted together or not at all.
  • The owner of the caller's own project cannot be deleted. The owner of a child project can.
  • After the delete, an account-deletion email is sent to the user's email address, if they have one. A failed email does not fail the request.
  • Returns { "success": true }.

Example

curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/user/Practitioner/c3499c27-2973-0a7f-807e-fb8676a92dcb' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

profileType*"Practitioner"
Value in"Practitioner"
profileId*string
Formatuuid

Response Body

User deleted successfully.

application/json
  1. response
success*boolean
Example Request
curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/user/Practitioner/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "success": true}

Send support message POST

Sends a support email on behalf of the signed-in user to the support address configured for this Ovok environment. **Auth:** Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant `Patient:read`, `Patient:search`, `Device:read`, `Device:search`, `Observation:read` and `Observation:search` (a project admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). ## Behaviour - Sends one email built from the `message`, `version` and `environment` you send. - The email also carries details taken from your session, not from the body: your name, email, project name, profile type, access policy name and tenant code. - Nothing else is written. - Returns `true` once the email is sent. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/support' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "message": "The live view does not load.", "version": "1.8.0", "environment": "production" }' ```

List zones GET

Lists the zones of your project with their device counts. A zone is a FHIR `Organization`. Use it for a zone overview; use `GET /v1/slim/zones/{zoneId}` for one zone's locations. **Auth:** Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant `Organization:search`, `Organization:read` and `Device:read` (an admin or super admin who holds no access policy skips this check). **Scope:** The caller's project (from the token). ## Behaviour - Counts are taken from the same rows as `GET /v1/slim/device/live`: only devices assigned to a resident are counted. `deviceCount` is the number of such devices in the zone; `activeDeviceCount` and `inactiveDeviceCount` split them by whether the device is currently active, as on the live view. - Only zones with at least one counted device are listed. A zone with no assigned devices does not appear; `GET /v1/slim/zones/device-counts?includeEmpty=true` lists it. - `search` keeps zones whose name contains the text, ignoring case. - `sortBy`: `name` (default), `deviceCount`, `activeDeviceCount` or `inactiveDeviceCount`. `orderBy`: `ASC` (default) or `DESC`. - Paging: `page` from 0, `count` from 1 to 100 (default 20). `total` is the number of zones after the search filter. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/zones?sortBy=deviceCount&orderBy=DESC&page=0&count=20' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```