Admin Set User Settings

cognitoidentityprovider_admin_set_user_settings

R Documentation

This action is no longer supported¶

Description¶

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. To configure either type of MFA, use admin_set_user_mfa_preference instead.

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

Usage¶

cognitoidentityprovider_admin_set_user_settings(UserPoolId, Username,
  MFAOptions)

Arguments¶

UserPoolId: [required] The ID of the user pool that contains the user whose options you're setting.
Username: [required] The username 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.
MFAOptions: [required] You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Value¶

An empty list.

Request syntax¶

svc$admin_set_user_settings(
  UserPoolId = "string",
  Username = "string",
  MFAOptions = list(
    list(
      DeliveryMedium = "SMS"|"EMAIL",
      AttributeName = "string"
    )
  )
)