@gravitywelluk/aws
Version:
Library of commonly used AWS wrapper functions to communicate with the AWS SDK
14 lines (13 loc) • 673 B
TypeScript
import type AWSModule from "aws-sdk";
export interface VerifyCognitoBasicUserAccountParams {
clientId: string;
confirmationCode: string;
email: string;
}
/**
* Verify a user's account by entering the confirmation code sent to them via text or email
* This code is checked and if it matches then the user's account is enabled and they can log in with the details they originally provided
*
* @param verifyBasicUserParams The parameters required to verify a user's account
*/
export declare const verifyBasicUserAccount: (verifyBasicUserParams: VerifyCognitoBasicUserAccountParams) => Promise<AWSModule.CognitoIdentityServiceProvider.ConfirmSignUpResponse>;