[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: separate out auth configuration
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: separate out auth configuration |
Date: |
Mon, 01 Mar 2021 11:47:03 +0100 |
This is an automated email from the git hooks/post-receive script.
dold pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 691baf2 separate out auth configuration
691baf2 is described below
commit 691baf2f742f27443bbfcca221715580f06d9ede
Author: Florian Dold <florian@dold.me>
AuthorDate: Mon Mar 1 11:46:51 2021 +0100
separate out auth configuration
---
core/api-merchant.rst | 56 +++++++++++++++++++++++++++++++++------------------
1 file changed, 36 insertions(+), 20 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index e2ec56c..5a9e6bf 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -826,20 +826,7 @@ Setting up instances
name: string;
// Authentication settings for this instance
- auth: {
- // Type of authentication.
- // "external": The mechant backend does not do
- // any authentication checks. Instead an API
- // gateway must do the authentication.
- // "token": The merchant checks an auth token.
- // See "token" for details.
- method: "external" | "token";
-
- // For method "external", this field is mandatory.
- // It specifies the "Authentication" HTTP header required to
- // authorize management to access the instance.
- token?: string;
- }
+ auth: InstanceAuthConfigurationMessage;
// The merchant's physical address (to be put into contracts).
address: Location;
@@ -873,6 +860,35 @@ Setting up instances
}
+.. http:post:: /private/instances/$INSTANCE/auth
+
+ Update the authentication settings for an instance.
+
+ **Request** the request must be an `InstanceAuthConfigurationMessage`.
+
+ :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.
+
+ .. ts:def:: InstanceAuthConfigurationMessage
+
+ interface InstanceAuthConfigurationMessage {
+ // Type of authentication.
+ // "external": The mechant backend does not do
+ // any authentication checks. Instead an API
+ // gateway must do the authentication.
+ // "token": The merchant checks an auth token.
+ // See "token" for details.
+ method: "external" | "token";
+
+ // For method "external", this field is mandatory.
+ // It specifies the "Authentication" HTTP header required to
+ // authorize management to access the instance.
+ token?: string;
+ }
+
+
.. http:patch:: /private/instances/$INSTANCE
Update the configuration of a merchant instance. PATCH operations against
@@ -904,12 +920,6 @@ Setting up instances
// Merchant name corresponding to this instance.
name: string;
- // "Authentication" header required to authorize management access the
instance.
- // Optional, if not given authentication will be disabled for
- // this instance (hopefully authentication checks are still
- // done by some reverse proxy).
- auth_token?: string;
-
// The merchant's physical address (to be put into contracts).
address: Location;
@@ -1039,6 +1049,12 @@ Inspecting instances
// offers we make be valid by default?
default_pay_deadline: RelativeTime;
+ // Authentication configuration.
+ // Does not contain the token when token auth is configured.
+ auth: {
+ type: "external" | "token";
+ };
+
}
.. ts:def:: MerchantAccount
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: separate out auth configuration,
gnunet <=