Amazon Cognito · JSON Structure

Cognito Idp Set User Pool Mfa Config Response Structure

SetUserPoolMfaConfigResponse schema from Amazon Cognito

Type: object Properties: 3
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

SmsMfaConfiguration SoftwareTokenMfaConfiguration MfaConfiguration

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "SmsMfaConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsMfaConfigType"
        },
        {
          "description": "The SMS text message MFA configuration."
        }
      ]
    },
    "SoftwareTokenMfaConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SoftwareTokenMfaConfigType"
        },
        {
          "description": "The software token MFA configuration."
        }
      ]
    },
    "MfaConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolMfaType"
        },
        {
          "description": "<p>The MFA configuration. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor enabled.</p> </li> </ul>"
        }
      ]
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-set-user-pool-mfa-config-response-structure.json",
  "name": "SetUserPoolMfaConfigResponse",
  "description": "SetUserPoolMfaConfigResponse schema from Amazon Cognito"
}