Follow the steps below to delete users via Quatrix API: 

  1. Log in to the account using GET /session/login.

  2. Get available users with GET /user and choose user_ids of the users you would like to delete.

  3. Execute the call POST /user/delete with following parameters:

    Name

    Type

    Default Value

    Description

    ids*


    string

    -

    IDs of the user

    delete_home


    boolean

    -

    Delete Home folder of the user

    * required parameters

  4. Get job_id from the previous call and make get /job/status/job_id. 

When the /job/status response property state is: 'SUCCESS', your selected users are deleted. 

Example Request URL

   HTTP POST    https://api-test.quatrix.it/api/1.0/user/delete

Request Payload

{
"ids": [
    "934d908f-7929-4090-8025-5309f96d618f",
    "8c73e30e-223e-4ebb-bf54-dd78d9a45154"],
  "delete_home": true
}
JS

Response Body

{
"job_id": "24947db9-8cbe-4496-9eeb-27e1f3408ec3"
}
JS