taler-docs

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

get-private-otp-devices.rst (817B)

      1 .. http:get:: [/instances/$INSTANCE]/private/otp-devices
      2 
      3   This is used to return the list of all the OTP devices.
      4 
      5   **Required permission:** ``otp-devices-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10      The backend has successfully returned all the templates. Returns a `OtpDeviceSummaryResponse`.
     11   :http:statuscode:`404 Not found`:
     12      The backend has does not know about the instance.
     13 
     14   **Details:**
     15 
     16   .. ts:def:: OtpDeviceSummaryResponse
     17 
     18     interface OtpDeviceSummaryResponse {
     19 
     20       // Array of devices that are present in our backend.
     21       otp_devices: OtpDeviceEntry[];
     22     }
     23 
     24   .. ts:def:: OtpDeviceEntry
     25 
     26     interface OtpDeviceEntry {
     27 
     28       // Device identifier.
     29       otp_device_id: string;
     30 
     31       // Human-readable description for the device.
     32       device_description: string;
     33     }