Skip to content

DeleteUser

Request

Delete user by specifying id or email. Either id or email is required. If both are provided then an error is returned. The user must have a token with valid permissions.

Endpoint: DELETE /v1/user. Authentication: requires AuthorizationHeader bearer token unless this operation's security is changed. Required AuthMind permission/scope: admin/user (grant this scope on the API token in Admin > API Tokens; a token without it receives 403 Forbidden). Documented parameters: email, id. Response parsing: inspect success; on failure inspect error, errors, or message depending on the referenced schema.

Security
AuthorizationHeader
Query
emailstring

Email of the user to delete

idstring

Id of the user to delete

curl -i -X DELETE \
  'https://apidoc.authmind.com/_mock/v1/docs/v1/user?email=string&id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request completed successfully. See the referenced schema for the response envelope and result payload.

Bodyapplication/json
errorsstring

Error message returned when the request fails. This is free-form, human-readable text intended for logging/display -- AuthMind does not define a stable, cross-endpoint error-code contract for it. Branch integration logic on the HTTP status code and the success boolean, not on the contents of this string.

successboolean

Indicates whether the request was successful.

Response
{
  "success": true
}