@gravitywelluk/aws/dist/cognito/create-cognito-basic-user.d.ts

Library of commonly used AWS wrapper functions to communicate with the AWS SDK

import type AWSModule from "aws-sdk";
export interface CreateCognitoBasicUserParams {
    userPoolId: string;
    clientId: string;
    email: string;
    password: string;
    groups?: string[];
}
/**
 * Creates a basic (non-admin) user in Cognito and triggers verification code
 *
 * This kind of user will be sent a verification code to their email address or phone number
 * Entering this and then calling confirmSignUp will enable the user's account
 *
 * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html#signUp-property
 * @param createBasicUserParams - The parameters required to create a basic Cognito user
 * @param awsCognitoConfigOverrides - Configuration option overrides
 */
export declare const createCognitoBasicUser: (createBasicUserParams: CreateCognitoBasicUserParams, awsCognitoConfigOverrides?: AWSModule.CognitoIdentityServiceProvider.ClientConfiguration) => Promise<AWSModule.CognitoIdentityServiceProvider.SignUpResponse>;