Amazon Cognito · JSON Structure

Cognito Idp Mfa Option List Type Structure

MFAOptionListType schema from Amazon Cognito

Type: array Properties: 0
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

MFAOptionListType is a JSON Structure definition published by Amazon Cognito. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "DeliveryMedium": {
        "allOf": [
          {
            "$ref": "#/components/schemas/DeliveryMediumType"
          },
          {
            "description": "The delivery medium to send the MFA code. You can use this parameter to set only the <code>SMS</code> delivery medium value."
          }
        ]
      },
      "AttributeName": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AttributeNameType"
          },
          {
            "description": "The attribute name of the MFA option type. The only valid value is <code>phone_number</code>."
          }
        ]
      }
    },
    "description": " <i>This data type is no longer supported.</i> Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations."
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-mfa-option-list-type-structure.json",
  "name": "MFAOptionListType",
  "description": "MFAOptionListType schema from Amazon Cognito"
}