Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
AdminsRecover Password

recoverPassword

POST
/api/v1/recover

Start password recovery for an administrator account. This public endpoint does not require authentication. When the request is accepted, Mist sends an email containing a recovery link such as https://manage.mist.com/verify/recover?token=:token. If CAPTCHA is required, include the CAPTCHA response token and provider flavor in the request body.

Request Body

application/json

Password recovery request submitted for an administrator account

email*string

Admin email address requesting password recovery

Lengthlength <= 64
recaptcha?string

CAPTCHA verification token submitted with the recovery request

recaptcha_flavor?recaptcha_flavor

CAPTCHA provider flavor used for recovery verification. enum: google, hcaptcha.

Default"google"

Value in

  • "google"
  • "hcaptcha"

Response Body

curl -X POST "https://example.com/api/v1/recover" \  -H "Content-Type: application/json" \  -d '{    "email": "test@mistsys.com",    "recaptcha": "string",    "recaptcha_flavor": "hcaptcha"  }'
Empty

lookup POST

Check the login method for an administrator email address. This public lookup is mainly used by UI clients to determine whether the user should continue with local login or be redirected to SSO.

verifyRecoverPassword POST

Verify a password recovery token from the recovery email. This public endpoint does not require authentication. When the token is valid, the user is authenticated for the recovery flow so the client can prompt for and submit a new password.