Manage user status

You can deactivate users, if these users are not active anymore but might become active again, and you want to keep their settings and encounter history (up to the retention period).

You can also remove users, which will also remove all settings and data related to this user. This action cannot be undone, so proceed with caution.

Note that if you re-provision or create an encounter for a previously deactivated user, it will make them active again automatically.

You can manage your provider users’ status using three endpoints :

Activate user

Call this method when you want to make a provider user active, using their external_provider_id

Creating an encounter for this user or (re)provisioning them also makes them active automatically.

Method: POST

Path: <baseUrl>/users/by_external_id/{external_provider_id}/activate

Payload: none

We will search for a provider user in your Nabla Connect instance that has the provided external_provider_id

If no user is found, we’ll return a 404 error.

Otherwise, we’ll make that user active and return a 204 success code. If the user was already active, we do nothing and return 204.

Deactivate user

Call this method when you want to deactivate a user using their external_provider_id

Method: POST

Path: <baseUrl>/users/by_external_id/{external_provider_id}/deactivate

Payload: none

We will search for a provider user in your Nabla Connect instance that has the provided external_provider_id

If no user is found, we’ll return a 404 error.

Otherwise, we’ll deactivate that user and return a 204 success code. If the user is already deactivated, we do nothing and return 204.

Remove a user

Call this method when you want to remove a user using their external_provider_id

⚠️ Removing a user will delete all their settings and encounter history, which cannot be undone. Use with caution.

Method: DELETE

Path: <baseUrl>/users/by_external_id/{external_provider_id}

Payload: none

We will search for a provider user in your Nabla Connect instance that has the provided external_provider_id

If no user is found, we’ll return a 404 error.

Otherwise, we’ll delete that user and return a 204 success code.