Class: Aws::CognitoIdentityProvider::Types::UserAttributeUpdateSettingsType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UserAttributeUpdateSettingsType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The settings for updates to user attributes. These settings include the property ‘AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see [ Verifying updates to email addresses and phone numbers].

This data type is a request and response parameter of

CreateUserPool][2

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes_require_verification_before_update ⇒ Array<String>

  Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

Instance Attribute Details

#attributes_require_verification_before_update ⇒ Array<String>

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a

VerifyUserAttribute][1

API request. You can also call the

AdminUpdateUserAttributes][2

API and set ‘email_verified` or

‘phone_number_verified` to true.

When ‘AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn’t require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where ‘AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user’s `email` or `phone_number` attribute.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 12013

class UserAttributeUpdateSettingsType < Struct.new(
  :attributes_require_verification_before_update)
  SENSITIVE = []
  include Aws::Structure
end