AdminSetUserSettingsRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the AdminSetUserSettings operation. This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.AdminSetUserSettingsRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class AdminSetUserSettingsRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The AdminSetUserSettingsRequest type exposes the following members

Constructors

	Name	Description
	AdminSetUserSettingsRequest()

Properties

Name Type Description

Name	Type	Description
MFAOptions	System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.MFAOptionType>	Gets and sets the property MFAOptions. You can use this parameter only to set an SMS configuration that uses SMS for delivery. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Username	System.String	Gets and sets the property Username. The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, this value must be the `sub` of a local user or the username of a user from a third-party IdP.
UserPoolId	System.String	Gets and sets the property UserPoolId. The ID of the user pool that contains the user whose options you're setting.

MFAOptions

System.Collections.Generic.List<Amazon.CognitoIdentityProvider.Model.MFAOptionType>

Gets and sets the property MFAOptions.

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Username

System.String

Gets and sets the property Username.

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

UserPoolId

System.String

Gets and sets the property UserPoolId.

The ID of the user pool that contains the user whose options you're setting.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer