User Mfa

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "The authenticated user's MFA configuration.",
  "properties": {
    "imageUrl": {
      "description": "An image URL that renders a QR code that can used to integration with\nauthentication apps.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "mfaPhone": {
      "description": "The phone number to be used with MFA. Required when MFA type is \"sms\".",
      "maxLength": 15,
      "nullable": true,
      "type": "string"
    },
    "mfaStatusId": {
      "description": "Represents the status of the MFA configuration. When\n\"pending-activation\", we will not enforce MFA. When \"activated\", we\nwill enforce MFA.",
      "enum": [
        "pending-activation",
        "activated"
      ],
      "nullable": true,
      "type": "string"
    },
    "mfaType": {
      "description": "The type of MFA configuration.",
      "enum": [
        "app",
        "sms"
      ],
      "nullable": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "user-mfa"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "mfaType"
  ],
  "type": "object"
}