Delete User
Endpoint: DELETE /api/users/{id}
Deletes a user permanently from the Conductor cluster. The invoking user must be an Admin to the Conductor cluster.
Path parameters
| Parameter | Description | Type | Required/ Optional |
|---|---|---|---|
| id | The email address of the user to delete. | string | Required |
Response
- Returns 200 OK, with a message that the user has been deleted.
- Returns 404 if an invalid user ID is provided.
- Returns 403 if a non-admin invokes the API.
Examples
Delete a user
Request
curl -X 'DELETE' \
'https://<YOUR-SERVER-URL>/api/users/user%40example.com' \
-H 'accept: application/json' \
-H 'X-Authorization: <TOKEN>'
Response
{
"message": "Deleted user 'user@example.com'"
}