| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CognitoIdentityProvider.AdminUpdateUserAttributes
Description
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
Synopsis
- data AdminUpdateUserAttributes = AdminUpdateUserAttributes' {
- clientMetadata :: Maybe (HashMap Text Text)
- userPoolId :: Text
- username :: Sensitive Text
- userAttributes :: [AttributeType]
- newAdminUpdateUserAttributes :: Text -> Text -> AdminUpdateUserAttributes
- adminUpdateUserAttributes_clientMetadata :: Lens' AdminUpdateUserAttributes (Maybe (HashMap Text Text))
- adminUpdateUserAttributes_userPoolId :: Lens' AdminUpdateUserAttributes Text
- adminUpdateUserAttributes_username :: Lens' AdminUpdateUserAttributes Text
- adminUpdateUserAttributes_userAttributes :: Lens' AdminUpdateUserAttributes [AttributeType]
- data AdminUpdateUserAttributesResponse = AdminUpdateUserAttributesResponse' {
- httpStatus :: Int
- newAdminUpdateUserAttributesResponse :: Int -> AdminUpdateUserAttributesResponse
- adminUpdateUserAttributesResponse_httpStatus :: Lens' AdminUpdateUserAttributesResponse Int
Creating a Request
data AdminUpdateUserAttributes Source #
Represents the request to update the user's attributes as an administrator.
See: newAdminUpdateUserAttributes smart constructor.
Constructors
| AdminUpdateUserAttributes' | |
Fields
| |
Instances
newAdminUpdateUserAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> AdminUpdateUserAttributes |
Create a value of AdminUpdateUserAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientMetadata:AdminUpdateUserAttributes', adminUpdateUserAttributes_clientMetadata - A map of custom key-value pairs that you can provide as input for any
custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminUpdateUserAttributes API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your AdminUpdateUserAttributes request.
In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
AdminUpdateUserAttributes, adminUpdateUserAttributes_userPoolId - The user pool ID for the user pool where you want to update user
attributes.
AdminUpdateUserAttributes, adminUpdateUserAttributes_username - The user name of the user for whom you want to update user attributes.
$sel:userAttributes:AdminUpdateUserAttributes', adminUpdateUserAttributes_userAttributes - An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the
same API request, include the email_verified or
phone_number_verified attribute, with a value of true. If you set
the email_verified or phone_number_verified value for an email or
phone_number attribute that requires verification to true, Amazon
Cognito doesn’t send a verification message to your user.
Request Lenses
adminUpdateUserAttributes_clientMetadata :: Lens' AdminUpdateUserAttributes (Maybe (HashMap Text Text)) Source #
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool
triggers. When you use the AdminUpdateUserAttributes API action, Amazon
Cognito invokes the function that is assigned to the custom message
trigger. When Amazon Cognito invokes this function, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute, which provides the data that you assigned to
the ClientMetadata parameter in your AdminUpdateUserAttributes request.
In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
- Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
- Validate the ClientMetadata value.
- Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
adminUpdateUserAttributes_userPoolId :: Lens' AdminUpdateUserAttributes Text Source #
The user pool ID for the user pool where you want to update user attributes.
adminUpdateUserAttributes_username :: Lens' AdminUpdateUserAttributes Text Source #
The user name of the user for whom you want to update user attributes.
adminUpdateUserAttributes_userAttributes :: Lens' AdminUpdateUserAttributes [AttributeType] Source #
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the
attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
To update the value of an attribute that requires verification in the
same API request, include the email_verified or
phone_number_verified attribute, with a value of true. If you set
the email_verified or phone_number_verified value for an email or
phone_number attribute that requires verification to true, Amazon
Cognito doesn’t send a verification message to your user.
Destructuring the Response
data AdminUpdateUserAttributesResponse Source #
Represents the response from the server for the request to update user attributes as an administrator.
See: newAdminUpdateUserAttributesResponse smart constructor.
Constructors
| AdminUpdateUserAttributesResponse' | |
Fields
| |
Instances
newAdminUpdateUserAttributesResponse Source #
Arguments
| :: Int | |
| -> AdminUpdateUserAttributesResponse |
Create a value of AdminUpdateUserAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AdminUpdateUserAttributesResponse', adminUpdateUserAttributesResponse_httpStatus - The response's http status code.
Response Lenses
adminUpdateUserAttributesResponse_httpStatus :: Lens' AdminUpdateUserAttributesResponse Int Source #
The response's http status code.