Skip to main content
Version: 2.1

ICognitoIdentityProviderAdminSetUserSettingsRequest

Interface in AWS.CognitoIdentityProvider

Interface for AdminSetUserSettings responses.

Ancestors​

Properties​

MFAOptions​

property MFAOptions: TList<ICognitoIdentityProviderMFAOptionType>

Type: ICognitoIdentityProviderMFAOptionType

Specify SMS configuration options.

Username​

property Username: string

Specify the Username of the user.

UserPoolId​

property UserPoolId: string

Specify the ID of the user pool.

Methods​

AddMFAOption​

function AddMFAOption(const AAttributeName, ADeliveryMedium: string): Integer;

Add a configuration option to MFAOptions.

Parameters

NameDescription
AAttributeNameThe attribute name of the MFA option type. The only valid value is.
ADeliveryMediumThe delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value. Valid values:|.

Returns

Returns the index of the option added to MFAOptions.