commit 9d43da7d53b3759fddcd72dc12c2492998a801b3
parent 3b48b728701ac1d8dca962b34ffc6d6d9c0158b3
Author: Christian Grothoff <christian@grothoff.org>
Date: Tue, 14 Oct 2025 20:35:14 +0200
spec change for #10498
Diffstat:
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1314,14 +1314,24 @@ Setting up instances
The request must be a `InstanceConfigurationMessage`.
+ :query token_validity_ms=DURATION: *Optional*.
+ Pass a non-zero DURATION in milliseconds to get a
+ refreshable login token for the SPA with the
+ given validity duration in the response. @since **v21**.
+
**Response:**
+ :http:statuscode:`200 Ok`:
+ The backend has successfully created the instance. Body will
+ be an `LoginTokenSuccessResponse` with a refreshable
+ login token for the SPA as requested. @since **v21**.
:http:statuscode:`202 Accepted`:
2FA is required for this operation, usually to validate the
email and/or phone numbers provided for the instance.
This returns the `ChallengeResponse`. @since **v21**
- :http:statuscode:`204 No content`:
- The backend has successfully created the instance.
+ :http:statuscode:`204 No Content`:
+ The backend has successfully created the instance. No login
+ token was requested, so nothing is returned.
:http:statuscode:`409 Conflict`:
This instance already exists, but with other configuration options.
Use "PATCH" to update an instance configuration. Alternatively,
@@ -1330,6 +1340,7 @@ Setting up instances
would be if a deleted but not purged instance is known under this
ID to the backend.
+
.. http:post:: /instances/$INSTANCE/forgot-password
Same as ``/management/instances/$INSTANCE/private/auth`` it will update the password of the instance but
