Skip to content
Tidepool API/Clinics API/
/
Update Clinician Security...

Update Clinician Security Profile

Request

Partially update the security profile of a clinician. Only the fields present in the request body are modified; omitted fields are left unchanged. Intended to be called by an event-based external system.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

Bodyapplication/json
mfaEnabledboolean

Whether multi-factor (two-factor) authentication is enabled for the clinician.

Example:true
mfaEnabledTimestring, (date-time)(Date/Time)

The time at which multi-factor (two-factor) authentication was enabled for the clinician.

Example:"2017-02-06T02:37:46Z"
identityProvidersArray of objects(Identity Provider)

The external identity providers linked to the clinician account.

lastLoginTimestring, (date-time)(Date/Time)

The time of the clinician's most recent successful login.

Example:"2017-02-06T02:37:46Z"
curl -i -X PATCH \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinicians/{userId}/securityProfile' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "mfaEnabled": true,
    "mfaEnabledTime": "2017-02-06T02:37:46Z",
    "identityProviders": [
      {
        "alias": "google",
        "name": "Google"
      }
    ],
    "lastLoginTime": "2017-02-06T02:37:46Z"
  }'

Responses

No content