taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

post-instances-INSTANCE-forgot-password.rst (1062B)

      1 .. http:post:: /instances/$INSTANCE/forgot-password
      2 
      3   Same as ``/management/instances/$INSTANCE/private/auth`` it will update the password of the instance but
      4   without requiring the current password. On the first call it will validate the request
      5   and return the multi-factor authentication challenge IDs with
      6   a ``202 Accepted`` response. Once the challenges are solved the
      7   request needs to be repeated with the ``Taler-Challenge-Ids`` header.
      8 
      9   This endpoint is **not** available for the ``admin`` instance.
     10   The administrator must use the command-line tool if they forgot
     11   their password.
     12 
     13   Since protocol **v21**.
     14 
     15   **Request** the request must be an `InstanceAuthConfigurationMessage`.
     16 
     17   **Response:**
     18 
     19   :http:statuscode:`202 Accepted`:
     20     2FA is required for this operation. This returns
     21     the `ChallengeResponse`. @since **v21**
     22   :http:statuscode:`204 No content`:
     23     The backend has successfully changed the credentials for the instance.
     24   :http:statuscode:`404 Not found`:
     25     This instance is unknown and thus cannot be reconfigured.