Location: Optional Features > API > API Endpoints > userDeactivate
userDeactivate HomeBack Next

Deactivate an LCMS user to disallow entry into the LCMS.

URL
ll_lcms/api/userDeactivate
Method
GET / POST or JSON
URL Parameters

 Required:

 token=[string as defined in LCMS Application Preferences]
 username=[string value, max length 200, accepts alphanumeric and underscores]

Success Response:

LCMS_U~1_img1104

Error Response

LCMS_U~1_img1103

 

Sample Call (GET)
 

 ll_lcms/api/userDeactivate/?token=xxx&username=jsmith
 

Note: The LCMS does not  physically delete users from the  system, but  makes them inactive or active in order to maintain referential integrity of stored data. Rather than listing each individual possible error message, only one example is shown above. The "detail" value will only appear if a coding error is detected, i.e. database error.