DELETE
/
api
/
user
Delete current user
curl --request DELETE \
  --url https://studio.edgeimpulse.com/v1/api/user \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "password": "<string>",
  "totpToken": "<string>"
}'
{
  "success": true,
  "error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
password
string

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

​
totpToken
string

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.

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
error
string

Optional error description (set if 'success' was false)