This API call is used to delete the user.

This action is a background action.

Resource URL

/api/1.0/user/delete

Resource Information

 

Response formatsJSON
Response code202
Requires authentication?Yes
HTTP MethodPOST

Parameters

 

Name TypeDefault ValueValidationDescription

ids

required

uuid[]-uuid4[]user IDs to delete

delete_home

optional

boolfalse-

determines if user home should be deleted with user

 

Example Request URL

https://quatrix.it/api/1.0/user/delete

Example Result

{
   	"job_id": <uuid>
}