taler-docs

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

patch-private-otp-devices-DEVICE_ID.rst (1281B)

      1 .. http:patch:: [/instances/$INSTANCE]/private/otp-devices/$DEVICE_ID
      2 
      3   This is used to update an OTP device. It is useful when we need to change information in the OTP device or when we have mistake some information.
      4 
      5   **Required permission:** ``otp-devices-write``
      6 
      7   **Request:**
      8 
      9   The request must be a `OtpDevicePatchDetails`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`204 No content`:
     14     The template has successfully modified.
     15   :http:statuscode:`404 Not found`:
     16     The template(ID) is unknown to the backend.
     17   :http:statuscode:`409 Conflict`:
     18     The provided information is inconsistent with the current state of the template. Changes made is the same with
     19     another store.
     20 
     21   **Details:**
     22 
     23   .. ts:def:: OtpDevicePatchDetails
     24 
     25    interface OtpDevicePatchDetails {
     26 
     27      // Human-readable description for the device.
     28      otp_device_description: string;
     29 
     30      // A key encoded with RFC 3548 Base32.
     31      // IMPORTANT: This is not using the typical
     32      // Taler base32-crockford encoding.
     33      // Instead it uses the RFC 3548 encoding to
     34      // be compatible with the TOTP standard.
     35      otp_key?: string;
     36 
     37      // Algorithm for computing the POS confirmation.
     38      otp_algorithm: Integer;
     39 
     40      // Counter for counter-based OTP devices.
     41      otp_ctr?: Integer;
     42    }