AWSCognitoIdentityProviderConfirmForgotPasswordRequest

Objective-C

@interface AWSCognitoIdentityProviderConfirmForgotPasswordRequest

Swift

class AWSCognitoIdentityProviderConfirmForgotPasswordRequest

The request representing the confirmation for a password reset.

Required parameters: [ClientId, Username, ConfirmationCode, Password]

  • The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsMetadataType *_Nullable analyticsMetadata;

    Swift

    var analyticsMetadata: AWSCognitoIdentityProviderAnalyticsMetadataType? { get set }
  • The app client ID of the app associated with the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientId;

    Swift

    var clientId: String? { get set }
  • 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 AWS Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation 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 ConfirmForgotPassword request. In your function code in AWS 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.

    Take the following limitations into consideration when you use the ClientMetadata parameter:

    • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

    • Amazon Cognito does not validate the ClientMetadata value.

    • Amazon Cognito does not encrypt the the ClientMetadata value, so don’t use it to provide sensitive information.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable clientMetadata;

    Swift

    var clientMetadata: [String : String]? { get set }
  • The confirmation code sent by a user’s request to retrieve a forgotten password. For more information, see

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable confirmationCode;

    Swift

    var confirmationCode: String? { get set }
  • The password sent by a user’s request to retrieve a forgotten password.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable password;

    Swift

    var password: String? { get set }
  • A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable secretHash;

    Swift

    var secretHash: String? { get set }
  • Contextual data such as the user’s device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderUserContextDataType *_Nullable userContextData;

    Swift

    var userContextData: AWSCognitoIdentityProviderUserContextDataType? { get set }
  • The user name of the user for whom you want to enter a code to retrieve a forgotten password.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable username;

    Swift

    var username: String? { get set }