User Delete API
This API endpoint allows you to delete a specific user from the system using their user_id.
Notice: Make sure the user_id is an urlencode string.
To remove a user, make a DELETE request to:
DELETE /v1/users/{user_id}
Replace {user_id} with the unique identifier of the user you wish to delete.
Response Format
The API will return a JSON object with a task_id that can be used to retrieve.
Example Error Response
{
"message": "deleted",
"data": {
"task_id": "{task_id}"
}
}
To check the exact response body of this task_id, make a GET request to the following endpoint:
GET /v1/users/_status/{task_id}
Replace {task_id} with the task_id returned from the response.
Authorizations
Your secret API key is used to access every Miso API endpoint. You should secure this key and only use it on a backend server. Never leave this key in your client-side JavaScript code. If the private key is compromised, you can revoke it in Dojo and get a new one.
Specify your secret key in the api_key query parameter. For example:
POST /v1/users?api_key=039c501ac8dfcac91c6f05601cee876e1cc07e17Path Parameters
The ID of the user.