Skip to main content
Version: 2.1

ICognitoIdentityProviderSetUserPoolMfaConfigRequest

Interface in AWS.CognitoIdentityProvider

Interface for SetUserPoolMfaConfig requests.

Ancestors​

Properties​

MfaConfiguration​

property MfaConfiguration: string

Specify the multi-factor authentication (MFA) configuration.

Valid values: - OFF: MFA will not be used. - ON: MFA is required for all users to sign in. - OPTIONAL: MFA is required for users who have activated an MFA option.

SmsMfaConfiguration​

property SmsMfaConfiguration: ICognitoIdentityProviderSmsMfaConfigType

Type: ICognitoIdentityProviderSmsMfaConfigType

Specify the SMS text message multi-factor authentication (MFA) configuration.

SoftwareTokenMfaConfiguration​

property SoftwareTokenMfaConfiguration: ICognitoIdentityProviderSoftwareTokenMfaConfigType

Type: ICognitoIdentityProviderSoftwareTokenMfaConfigType

Specify the software token multi-factor authentication (MFA) configuration.

UserPoolId​

property UserPoolId: string

Specify the ID of the user pool.