Amazon Cognito · Schema

SmsMfaConfigType

The SMS text message multi-factor authentication (MFA) configuration type.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
SmsAuthenticationMessage object
SmsConfiguration object
View JSON Schema on GitHub

JSON Schema

user-pools-sms-mfa-config-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-sms-mfa-config-type-schema.json",
  "title": "SmsMfaConfigType",
  "description": "The SMS text message multi-factor authentication (MFA) configuration type.",
  "type": "object",
  "properties": {
    "SmsAuthenticationMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsVerificationMessageType"
        },
        {
          "description": "The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the \u2018{####}\u2019 placeholder, which is replaced with the code. If the message isn't included, and default message will be used."
        }
      ]
    },
    "SmsConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsConfigurationType"
        },
        {
          "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account."
        }
      ]
    }
  }
}