v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Two Factor Authentication

List Code Generators

This endpoint helps you return a list of all code generators previously configured.

get/v1/2fa

Query parameters

limitinteger

Use limit operator to limit the number of records returned

skipinteger

Use skip operator to skip the specified number of records.

offsetstring

Use offset operator to search the next record to be consulted

sortstring

Useful to sort returned records (Sorting works only for pagination with skip and limit)

selectstring

Useful to limit fields to return in each records

Response

Succeed, 2FA Information Retrieved

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "pagination": {
    "offset": "e3293115e2ec5f466c67e047",
    "limit": 6,
    "next": "5f466c67e047e3293115e2ec",
    "page": 1,
    "pages": 10,
    "total": 1000
  },
  "items": [
    {
      "id": 1,
      "codeLength": 5,
      "expirationMinutes": 10,
      "channels": [
        {
          "subject": "Your verification code",
          "shortcode": "1234",
          "from": "noreply@example.com",
          "text": "Verification code: {0}",
          "placeholder": "code",
          "address": "1234",
          "templateName": "2fa_template",
          "templateId": "2fa_template",
          "templateLanguage": "en",
          "type": "SMS"
        }
      ]
    }
  ]
}