getUserAttributeVerificationCode method
Given an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In 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.
May throw CodeDeliveryFailureException.
May throw ForbiddenException.
May throw InternalErrorException.
May throw InvalidEmailRoleAccessPolicyException.
May throw InvalidLambdaResponseException.
May throw InvalidParameterException.
May throw InvalidSmsRoleAccessPolicyException.
May throw InvalidSmsRoleTrustRelationshipException.
May throw LimitExceededException.
May throw NotAuthorizedException.
May throw OperationNotEnabledException.
May throw PasswordResetRequiredException.
May throw ResourceNotFoundException.
May throw TooManyRequestsException.
May throw UnexpectedLambdaException.
May throw UserLambdaValidationException.
May throw UserNotConfirmedException.
May throw UserNotFoundException.
Parameter accessToken :
A valid access token that Amazon Cognito issued to the currently signed-in
user. Must include a scope claim for
aws.cognito.signin.user.admin.
Parameter attributeName :
The name of the attribute that the user wants to verify, for example
email.
Parameter 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 Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a
clientMetadata attribute that provides the data that you
assigned to the ClientMetadata parameter in your request. In your function
code, you can process the clientMetadata value to enhance
your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
-
Store the
ClientMetadatavalue. 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, theClientMetadataparameter serves no purpose. -
Validate the
ClientMetadatavalue. -
Encrypt the
ClientMetadatavalue. Don't send sensitive information in this parameter.
Implementation
Future<GetUserAttributeVerificationCodeResponse>
getUserAttributeVerificationCode({
required String accessToken,
required String attributeName,
Map<String, String>? clientMetadata,
}) async {
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target':
'AWSCognitoIdentityProviderService.GetUserAttributeVerificationCode'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
signed: false,
// TODO queryParams
headers: headers,
payload: {
'AccessToken': accessToken,
'AttributeName': attributeName,
if (clientMetadata != null) 'ClientMetadata': clientMetadata,
},
);
return GetUserAttributeVerificationCodeResponse.fromJson(jsonResponse.body);
}