taler-docs

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

post-management-auditors.rst (1339B)

      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   :http:statuscode:`409 Conflict`:
     16     The exchange has a more recent request related to this auditor key (replay detected).
     17 
     18   **Details:**
     19 
     20   .. ts:def:: AuditorSetupMessage
     21 
     22     interface AuditorSetupMessage {
     23 
     24       // Base URL of the auditor.
     25       auditor_url: string;
     26 
     27       // Human-readable name of the auditor.
     28       auditor_name: string;
     29 
     30       // The auditor's EdDSA signing public key.
     31       auditor_pub: EddsaPublicKey;
     32 
     33       // Signature by the exchange master ke yover a
     34       // `TALER_MasterAddAuditorPS`.
     35       // Must have purpose ``TALER_SIGNATURE_MASTER_ADD_AUDITOR``.
     36       master_sig: EddsaSignature;
     37 
     38       // When does the auditor become active?
     39       // Should be the time when the signature was created,
     40       // using the (monotonic!) local time of the system
     41       // with the offline master public key. Note that
     42       // even if the time is in the future, the auditor will
     43       // become active immediately! Used ONLY to detect replay attacks.
     44       validity_start: Timestamp;
     45 
     46     }