taler-docs

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

post-register.rst (1328B)


      1 .. http:post:: /register
      2 
      3   Requests the registration or update of a mailbox.
      4   May be used to update encryption keys.
      5   May incur cost.
      6   The mailbox identity is given through the keys field
      7   in the ``MailboxMetadata`` field.
      8 
      9   **Request**
     10 
     11   The body of the request must be a ``MailboxRegistrationRequest``.
     12 
     13   **Details:**
     14 
     15   .. _MailboxRegistrationRequest:
     16   .. ts:def:: MailboxRegistrationRequest
     17 
     18     interface MailboxRegistrationRequest {
     19 
     20       // Keys to add/update for the mailbox.
     21       mailbox_metadata: MailboxMetadata;
     22 
     23       // Signature by the mailbox's signing key affirming
     24       // the update of keys, of purpose
     25       // ``TALER_SIGNATURE_MAILBOX_REGISTER``.
     26       // The signature is created over the SHA-512 hash
     27       // of (encryptionKeyType||encryptionKey||expiration)
     28       // Base32 crockford-encoded.
     29       // The signature system is defined through the
     30       // signing_key_type in the keys field.
     31       signature: string;
     32 
     33     }
     34 
     35   **Response**
     36 
     37   :http:statuscode:`204 No Content`:
     38      Update/creation complete.
     39   :http:statuscode:`403 Forbidden`:
     40      The ``signature`` is invalid.
     41      This response comes with a standard `ErrorDetail` response.
     42   :http:statuscode:`402 Payment Required`
     43      Client needs to make a Taler payment before proceeding. See
     44      standard Taler payment procedure.