16.1.1.16. Recover endpoints

This module provides the REST API for th password recovery for a user managed in privacyIDEA.

The methods are also tested in the file tests/test_api_register.py

POST /recover/reset

reset the password with a given recovery code. The recovery code was sent by get_recover_code and is bound to a certain user.

JSON Parameters:  

• recoverycode – The recoverycode sent the the user
• password – The new password of the user

Return:

a json result with a boolean “result”: true

POST /recover

This method requests a recover code for a user. The recover code it sent via email to the user.

Query Parameters:  

• user – username of the user
• realm – realm of the user
• email – email of the user

Return:

JSON with value=True or value=False