{
  "opencollection": "1.0.0",
  "info": {
    "name": "Narmi Public account balances mfa API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "mfa",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List MFA devices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.narmi.dev/v1/mfa/",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The initial index from which to return the results."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/v2/oauth/authorize/",
              "accessTokenUrl": "/v2/oauth/token/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the authenticated user's MFA devices.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\n<i>How can we improve these docs?             <a href=\"mailto:docs+feedback@narmi.com\">Share your feedback.</a></i>"
        },
        {
          "info": {
            "name": "Delete MFA device",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sandbox.narmi.dev/v1/mfa/:id/",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "MFA device ID, constituted by a string of the device type followed by a device ID e.g. `otp_twilio.models.TwilioSMSDevice/1`."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/v2/oauth/authorize/",
              "accessTokenUrl": "/v2/oauth/token/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete a user's MFA device.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\n<i>How can we improve these docs?             <a href=\"mailto:docs+feedback@narmi.com\">Share your feedback.</a></i>"
        },
        {
          "info": {
            "name": "Retrieve sudo status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.narmi.dev/v1/sudo/",
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/v2/oauth/authorize/",
              "accessTokenUrl": "/v2/oauth/token/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve information on whether the current user has sudo permissions.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents). For example, $10.00 is represented as 1000.\n\n\n\n<i>How can we improve these docs?             <a href=\"mailto:docs+feedback@narmi.com\">Share your feedback.</a></i>"
        },
        {
          "info": {
            "name": "Elevate sudo permissions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.narmi.dev/v1/sudo/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/v2/oauth/authorize/",
              "accessTokenUrl": "/v2/oauth/token/",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Elevate user permissions using Two-Factor-Authentication. \n\n\n\nSend a `device_id` to generate and dispatch a one-time-password to the specified device. \n\n\n\nSend `device_id` and `one_time_password` to validate the OTP sent to a user. \n\n\n\nThe endpoint will return a `403` if there is an issue with the `device_id` or `one_time_password`, or if the user has no registered 2FA devices.\n\nAll monetary values are represented in minor units, or the smallest unit of the currency with no decimal (e.g., cents)"
        }
      ]
    }
  ],
  "bundled": true
}