taler-docs

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

post-management-auditors.rst (1820B)

      1 .. http:post:: /management/auditors
      2 
      3   This request will be used to enable an auditor.
      4 
      5   **Request:**
      6 
      7   The request must be a `AuditorSetupMessage`.
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`204 No content`:
     12     The auditor was successfully enabled.
     13   :http:statuscode:`403 Forbidden`:
     14     The master signature is invalid.
     15     Returned with an error code of
     16     ``TALER_EC_EXCHANGE_MANAGEMENT_AUDITOR_ADD_SIGNATURE_INVALID``.
     17   :http:statuscode:`409 Conflict`:
     18     The exchange has a more recent request related to this auditor key (replay detected).
     19     Returned with an error code of
     20     ``TALER_EC_EXCHANGE_MANAGEMENT_AUDITOR_MORE_RECENT_PRESENT``.
     21   :http:statuscode:`500 Internal Server Error`:
     22     The server experienced an internal error.
     23     This response comes with a standard `ErrorDetail` response.
     24     Possible error codes include
     25     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` or
     26     ``TALER_EC_GENERIC_DB_STORE_FAILED``.
     27 
     28   **Details:**
     29 
     30   .. ts:def:: AuditorSetupMessage
     31 
     32     interface AuditorSetupMessage {
     33 
     34       // Base URL of the auditor.
     35       auditor_url: string;
     36 
     37       // Human-readable name of the auditor.
     38       auditor_name: string;
     39 
     40       // The auditor's EdDSA signing public key.
     41       auditor_pub: EddsaPublicKey;
     42 
     43       // Signature by the exchange master ke yover a
     44       // `TALER_MasterAddAuditorPS`.
     45       // Must have purpose ``TALER_SIGNATURE_MASTER_ADD_AUDITOR``.
     46       master_sig: EddsaSignature;
     47 
     48       // When does the auditor become active?
     49       // Should be the time when the signature was created,
     50       // using the (monotonic!) local time of the system
     51       // with the offline master public key. Note that
     52       // even if the time is in the future, the auditor will
     53       // become active immediately! Used ONLY to detect replay attacks.
     54       validity_start: Timestamp;
     55 
     56     }