LUlumahealth
users

Delete a user

Changed on
delete/users/{userId}

Request

Path parameters

userIdstring required

Users' unique identifier in Luma's database.

Response

Deleted user

_idstring

Luma's internal ID of an object.

safeIdstring

safeId

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

namestring

Full name

firstnamestring

First name

lastnamestring

Last name

middlenamestring

Middle name

alternativeNamestring

Alternative name

normalizedNamestring

normalizedName

displayPhonestring

Phone number displayed in staff profile. Not used for communication purposes.

displayStatus'active' | 'pending' | 'suspended'

Account status. Informative field only, not used for access control.

emailstring

User's e-mail address in lowercase.

rolesstring[]

User's roles, used for access control.

organizationstring

The ID of the organization controling this root user account.

doNotContactboolean

Indicates if the user has requested not to be contacted anymore.

doNotContactMessagestring

The ID of the message where the user requested not to be contacted anymore.

groupsstring[]

List of group IDs to which this user belongs.

stripeCustomerIdstring

Customer ID from stripe for this account

stripeSubscriptionIdstring

Stripe subscription ID

salesforceIdstring

Salesforce Account ID for this account

activenumber

Indicates if a user is active and able to log into the system or not.

languagestring

User's preferred language.

addressstring

User's address.

citystring

User's city.

statestring

User's state.

countrystring

User's country

postcodestring

User's postal code.

gender'male' | 'female' | 'unknown' | 'nonbinary'

User's gender.

avatarstring

The ID of a FileUpload containing the profile picture of the user.

directMessagingEmailstring

E-mail for direct communication with the user.

websitestring

User's website.

settingstring

ID of Setting

type'doctor' | 'staff' | 'patient' | 'guest'

type

lastLoginstring date-time

lastLogin

masterboolean

master

allowedIpsstring[]

allowedIps

publicKeystring

publicKey

Changes

  • f19aeba84a26Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status