AWSCognitoIdentityProviderAdminResetUserPasswordRequest

Objective-C

@interface AWSCognitoIdentityProviderAdminResetUserPasswordRequest

Swift

class AWSCognitoIdentityProviderAdminResetUserPasswordRequest

Represents the request to reset a user’s password as an administrator.

Required parameters: [UserPoolId, Username]

  • 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 AdminResetUserPassword 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 AdminResetUserPassword 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 user pool ID for the user pool where you want to reset the user’s password.

    Declaration

    Objective-C

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

    Swift

    var userPoolId: String? { 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, you can also use their sub in this request.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }