JUjumpcloud
Systemusers

Delete a system user

This endpoint allows you to delete a particular system user.

Sample Request

curl -X DELETE https://console.jumpcloud.com/api/systemusers/{UserID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
delete/api/systemusers/{id}

Request

Query parameters

cascade_managerstring

This is an optional flag that can be enabled on the DELETE call, DELETE /systemusers/{id}?cascade_manager=null. This parameter will clear the Manager attribute on all direct reports and then delete the account.

Headers

x-org-idstring

Response

OK

_idstring
account_lockedboolean
account_locked_datestring nullable
activatedboolean
allow_public_keyboolean
alternateEmailstring
badLoginAttemptsinteger
companystring
costCenterstring
createdstring
departmentstring
descriptionstring
disableDeviceMaxLoginAttemptsboolean
displaynamestring
emailstring
employeeIdentifierstring

Must be unique per user.

employeeTypestring
enable_managed_uidboolean
enable_user_portal_multifactorboolean
external_dnstring
external_password_expiration_datestring
external_source_typestring
externally_managedboolean

The externally_managed property has been deprecated. Whenever a user has their externally_managed field modified their restrictedFields property gets populated with the appropriate value, even if it is already set to a value an administrator manually set.

firstnamestring
jobTitlestring
lastnamestring
ldap_binding_userboolean
locationstring
managerstring

Relation with another systemuser to identify the last as a manager.

middlenamestring
organizationstring
password_datestring nullable
password_expiration_datestring nullable
password_expiredboolean
password_never_expiresboolean
passwordless_sudoboolean
public_keystring
samba_service_userboolean
state'STAGED' | 'ACTIVATED' | 'SUSPENDED'
sudoboolean
suspendedboolean
tagsstring[]
totp_enabledboolean
unix_guidinteger
unix_uidinteger
usernamestring
managedAppleIdstring
creationSourcestring

Changes

No recorded changes to this operation across all 1 revision of this API.