DELETE /api/v1/users/{user_email}

Delete a given user.

Please note that this call does not remove the data from the database but only disables the user: the user can no longer login and is no longer counted in the license number (if user licenses apply to your contrat). This behaviour is needed for coherent statistics of training resources in the dashboard.

If you create this user again (reactivation), the user will keep his programs, managers, managed users, learning statistics, labels and password but will lose his groups.

Fields

Servers

Path parameters

Name Type Required Description
user_email String Yes

user’s mail

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
company String No

(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.

apiKey String No

(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.

Request body fields

Name Type Required Description
company String No
apiKey String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.