commit 8bb6189041537bd6ffe1d1fe40e3feb4cc7de313 parent 54321d879cca081ecb1f905a7d4ef399a14cb3a9 Author: Sebastian <sebasjm@gmail.com> Date: Tue, 5 Aug 2025 13:33:12 +0200 add forgot password endpoint Diffstat:
| M | core/api-merchant.rst | | | 18 | ++++++++++++++++++ |
1 file changed, 18 insertions(+), 0 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -1248,6 +1248,24 @@ Setting up instances would be if a deleted but not purged instance is known under this ID to the backend. +.. http:post:: /forgot-password/$INSTANCE + + Same as ``/management/instances/$INSTANCE/auth`` it will update the password of the instance but + without requiring the current password. On the first call it will validate the request + and return the challenge id with a 202 response. Once the challenge is solved the + request needs to be repeated with the X-Challenge-Id header. + + **Request** the request must be an `InstanceAuthConfigurationMessage`. + + **Response:** + + :http:statuscode:`202 Accepted`: + 2FA is required for this operation. This returns the `Challenge` response. @since **v21** + :http:statuscode:`204 No content`: + The backend has successfully created the instance. + :http:statuscode:`404 Not found`: + This instance is unknown and thus cannot be reconfigured. + .. http:post:: /management/instances