PATIENT_LOGIN_ENABLED
Pause or resume patient sign-in for a project without affecting practitioners.
Controls whether patients can sign in to the project. Turn it off to pause patient sign-in while practitioners keep working.
| Type | Boolean setting |
| Change with | PUT /v1/project/settings/PATIENT_LOGIN_ENABLED |
| Who can change it | Project admin |
| When unset | Patient sign-in is on, although GET /v1/project/settings reports false |
| Set on new projects | false for child projects created with POST /v1/slim/project/child; not set by any other project-creation route |
| Inherited | No. A child project reads only its own value. |
Turn patient sign-in off
curl --request PUT \
--url 'https://api.sandbox.ovok.com/v1/project/settings/PATIENT_LOGIN_ENABLED' \
--header "Authorization: Bearer ${OVOK_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{"enabled":false}'The response is the full settings record. The change applies to the next request; there is no cache to wait for.
Which sign-in this applies to
Tenant sign-in (/v1/auth/tenant/Patient/...) is the current way to sign in to an Ovok project. Every project has a tenant code, which names the project in the request. The older routes in the table below still work and are listed because the switch covers them too: POST /auth/login, TAN sign-in, /auth/external/* and /auth/signup are marked deprecated, and POST /v2/auth/login is the older client-ID sign-in that the platform's own code says to replace with tenant sign-in.
Where the switch applies
| Sign-in path | Checked today? |
|---|---|
POST /v1/auth/tenant/Patient/login/start | Yes |
POST /v2/auth/login and the deprecated POST /auth/login | Yes |
POST /auth/signup with resourceType Patient and a password (the automatic sign-in after sign-up) | Yes, but see the sign-up gotcha |
POST /v1/auth/tenant/Patient/login/mfa and login/token | No |
TAN sign-in (POST /auth/login/tan, /auth/tan-login/:tan) | Yes |
Google and Apple sign-in (POST /auth/external/google, /auth/external/apple) | Yes |
Token refresh (POST /v1/auth/refresh-token, /oauth2/token) | Yes |
POST /v1/auth/tenant/Patient/register (returns tokens on success) | No |
Treat the table as the contract for your current release and test the paths your app uses.
What callers see when it is off
| Route | Status | Message |
|---|---|---|
POST /v1/auth/tenant/Patient/login/start | 403 | Login is not enabled. |
POST /v2/auth/login | 403 | Login is not enabled for this project. |
POST /auth/signup (patient, with password) | 400 | Login is not enabled for this project. |
POST /auth/external/google, /auth/external/apple | 403 | Login is not enabled for this project. |
POST /v1/auth/refresh-token | 403 | Login is not enabled for this project. |
POST /oauth2/token (refresh grant) | 403 | access_denied, with error_description Login is not enabled for this project. |
| TAN sign-in | 400 | No message. |
On the tenant route, an unknown tenant code answers 404 Tenant not found. before the switch is checked.
Gotchas
- Turning it off ends sessions at the next refresh. A patient who is already signed in keeps working until the access token expires, up to 60 minutes; the next token refresh is refused with
403. To end a session at once, revoke it withDELETE /v1/auth/session/:idorPOST /v1/auth/logout. - A session code issued before the switch changed still works. A code from
login/startcan be redeemed atlogin/tokenafter you turn the switch off. GETshowsfalsefor a project that has never set it, but patients can sign in. Set the key to the value you intend rather than relying on the default. See Unset settings.- Projects created with
POST /v1/slim/project/childstart with patient sign-in off. Turn it on before you launch a patient app. - Sign-up can create the account and still answer
400.POST /auth/signupcreates the patient, then signs them in. With the switch off, the account exists but the call returns400 Login is not enabled for this project. - A failed read looks like "off". If the project cannot be read for a moment, the check fails closed and callers see the same
403as when the switch is off. - Rate limit.
login/startallows 10 requests per minute per client address; over that returns429. - Registration is separate. A patient who registers through
POST /v1/auth/tenant/Patient/registerreceives tokens even when this switch is off. Use PATIENT_REGISTRATION_ENABLED to stop registration.
Related
- Patient sign-in, the flow this switch controls
- PRACTITIONER_LOGIN_ENABLED
- PATIENT_REGISTRATION_ENABLED
- Settings are not permissions
Last updated on