Amazon Cognito · JSON Structure

Cognito Idp Software Token Mfa Settings Type Structure

The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

Type: object Properties: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

Enabled PreferredMfa

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted."
        }
      ]
    },
    "PreferredMfa": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "Specifies whether software token MFA is the preferred MFA method."
        }
      ]
    }
  },
  "description": "The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-software-token-mfa-settings-type-structure.json",
  "name": "SoftwareTokenMfaSettingsType"
}