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 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 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.

    Declaration

    Objective-C

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

    Swift

    var clientMetadata: [String : String]? { get set }

  • The confirmation code from your user’s request to reset their password. For more information, see ForgotPassword.

    Declaration

    Objective-C

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

    Swift

    var confirmationCode: String? { get set }

  • The new password that your user wants to set.

    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. For more information about SecretHash, see Computing secret hash values.

    Declaration

    Objective-C

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

    Swift

    var secretHash: String? { get set }

  • Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

    Declaration

    Objective-C

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

    Swift

    var userContextData: AWSCognitoIdentityProviderUserContextDataType? { get set }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }