Delete user

Delete user

delete

Delete a user. This function is only available through a JWT token, and can only remove the current user.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

userIdintegerRequired

User ID

Body

passwordstringOptional

User's current password. Required if the user has a password set.

totpTokenstringOptional

TOTP Token. Required if a user has multi-factor authentication with a TOTP token enabled. If a user has MFA enabled, but no totpToken is submitted; then an error starting with "ERR_TOTP_TOKEN IS REQUIRED" is returned. Use this to then prompt for an MFA token and re-try this request.

Responses

application/json

objectOptional

delete

HTTPcURLJavaScriptPython

DELETE /v1/api/users/{userId} HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "password": "text",
  "totpToken": "text"
}

200

OK

{
  "success": true,
  "error": "text"
}