Amazon Cognito · JSON Structure

User Pools Admin Set User Mfa Preference Request Structure

AdminSetUserMFAPreferenceRequest schema from Amazon Cognito API

Type: object Properties: 4 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

SMSMfaSettings SoftwareTokenMfaSettings Username UserPoolId

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-admin-set-user-mfa-preference-request-structure.json",
  "name": "AdminSetUserMFAPreferenceRequest",
  "description": "AdminSetUserMFAPreferenceRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "SMSMfaSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SMSMfaSettingsType"
        },
        {
          "description": "The SMS text message MFA settings."
        }
      ]
    },
    "SoftwareTokenMfaSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SoftwareTokenMfaSettingsType"
        },
        {
          "description": "The time-based one-time password software token MFA settings."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user pool username or alias."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    }
  },
  "required": [
    "Username",
    "UserPoolId"
  ]
}