Amazon Cognito · JSON Structure

Cognito Idp Set User Mfa Preference Request Structure

SetUserMFAPreferenceRequest schema from Amazon Cognito

Type: object Properties: 3 Required: 1
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

SMSMfaSettings SoftwareTokenMfaSettings AccessToken

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "SMSMfaSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SMSMfaSettingsType"
        },
        {
          "description": "The SMS text message multi-factor authentication (MFA) settings."
        }
      ]
    },
    "SoftwareTokenMfaSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SoftwareTokenMfaSettingsType"
        },
        {
          "description": "The time-based one-time password (TOTP) software token MFA settings."
        }
      ]
    },
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set."
        }
      ]
    }
  },
  "required": [
    "AccessToken"
  ],
  "$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-mfa-preference-request-structure.json",
  "name": "SetUserMFAPreferenceRequest",
  "description": "SetUserMFAPreferenceRequest schema from Amazon Cognito"
}