Delete user

Delete user

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

delete

/api/users/{userId}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

userIdintegerrequired

User ID

Body

passwordstring

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

totpTokenstring

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://studio.edgeimpulse.com/v1/api/users/{userId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

200

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

OK