(Node.js) Amazon Cognito - Create User Pool

See more Amazon Cognito Examples

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

For more information, see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();
    var success;

    var authAws = new chilkat.AuthAws();
    authAws.AccessKey = "AWS_ACCESS_KEY";
    authAws.SecretKey = "AWS_SECRET_KEY";
    // Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
    authAws.Region = "us-west-2";
    authAws.ServiceName = "cognito-idp";
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    rest.SetAuthAws(authAws);

    // URL: https://cognito-idp.us-west-2.amazonaws.com/
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    // Use the same region as specified above.
    success = rest.Connect("cognito-idp.us-west-2.amazonaws.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    // Note: The above code does not need to be repeatedly called for each REST request.
    // The rest object can be setup once, and then many requests can be sent.  Chilkat will automatically
    // reconnect within a FullRequest* method as needed.  It is only the very first connection that is explicitly
    // made via the Connect method.

    // Use this online tool to generate code from sample JSON:
    // Generate Code to Create JSON

    // The following JSON is sent in the request body.
    // This example wil demonstrate creating a pool with many options specified.
    // The only required JSON member is "PoolName".

    // {
    //     "AccountRecoverySetting": {
    //       "RecoveryMechanisms": [
    //         {
    //           "Name": "verified_phone_number",
    //           "Priority": 1
    //         },
    //         {
    //           "Name": "verified_email",
    //           "Priority": 2
    //         }
    //       ]
    //     },
    //     "AdminCreateUserConfig": {
    //       "AllowAdminCreateUserOnly": false,
    //       "InviteMessageTemplate": {
    //         "EmailMessage": "Your username is {username} and temporary password is {####}. ",
    //         "EmailSubject": "Your temporary password",
    //         "SMSMessage": "Your username is {username} and temporary password is {####}. "
    //       },
    //       "TemporaryPasswordValidityDays": 7
    //     },
    //     "AutoVerifiedAttributes": [
    //       "email",
    //       "phone_number"
    //     ],
    //     "EmailConfiguration": {
    //       "EmailSendingAccount": "DEVELOPER",
    //       "From": "joe@example.com",
    //       "ReplyToEmailAddress": "joe@example.com",
    //       "SourceArn": "arn:aws:ses:us-west-2:954491834127:identity/joe@example.com"
    //     },
    //     "EmailVerificationMessage": "Your verification code is {####}. ",
    //     "EmailVerificationSubject": "Your verification code",
    //     "LambdaConfig": {},
    //     "MfaConfiguration": "OFF",
    //     "PoolName": "MyTestPool",
    //     "Policies": {
    //       "PasswordPolicy": {
    //         "MinimumLength": 8,
    //         "RequireLowercase": true,
    //         "RequireNumbers": true,
    //         "RequireSymbols": true,
    //         "RequireUppercase": true,
    //         "TemporaryPasswordValidityDays": 7
    //       }
    //     },
    //     "Schema": [
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": false,
    //         "Name": "sub",
    //         "Required": true,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "1"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "name",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "given_name",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "family_name",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "middle_name",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "nickname",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "preferred_username",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "profile",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "picture",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "website",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "email",
    //         "Required": true,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "Boolean",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "email_verified",
    //         "Required": false
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "gender",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "birthdate",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "10",
    //           "MinLength": "10"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "zoneinfo",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "locale",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "phone_number",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "String",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "address",
    //         "Required": false,
    //         "StringAttributeConstraints": {
    //           "MaxLength": "2048",
    //           "MinLength": "0"
    //         }
    //       },
    //       {
    //         "AttributeDataType": "Number",
    //         "DeveloperOnlyAttribute": false,
    //         "Mutable": true,
    //         "Name": "updated_at",
    //         "NumberAttributeConstraints": {
    //           "MinValue": "0"
    //         },
    //         "Required": false
    //       }
    //     ],
    //     "SmsAuthenticationMessage": "Your verification code is {####}. ",
    //     "SmsConfiguration": {
    //       "ExternalId": "94b17737-216b-4cf7-a29e-17e990e91300",
    //       "SnsCallerArn": "arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role"
    //     },
    //     "SmsVerificationMessage": "Your verification code is {####}. ",
    //     "UsernameConfiguration": {
    //       "CaseSensitive": false
    //     },
    //     "VerificationMessageTemplate": {
    //       "DefaultEmailOption": "CONFIRM_WITH_CODE",
    //       "EmailMessage": "Your verification code is {####}. ",
    //       "EmailSubject": "Your verification code",
    //       "SmsMessage": "Your verification code is {####}. "
    //     }
    //   }
    // 

    var json = new chilkat.JsonObject();
    json.UpdateString("AccountRecoverySetting.RecoveryMechanisms[0].Name","verified_phone_number");
    json.UpdateInt("AccountRecoverySetting.RecoveryMechanisms[0].Priority",1);
    json.UpdateString("AccountRecoverySetting.RecoveryMechanisms[1].Name","verified_email");
    json.UpdateInt("AccountRecoverySetting.RecoveryMechanisms[1].Priority",2);
    json.UpdateBool("AdminCreateUserConfig.AllowAdminCreateUserOnly",false);
    json.UpdateString("AdminCreateUserConfig.InviteMessageTemplate.EmailMessage","Your username is {username} and temporary password is {####}. ");
    json.UpdateString("AdminCreateUserConfig.InviteMessageTemplate.EmailSubject","Your temporary password");
    json.UpdateString("AdminCreateUserConfig.InviteMessageTemplate.SMSMessage","Your username is {username} and temporary password is {####}. ");
    json.UpdateInt("AdminCreateUserConfig.TemporaryPasswordValidityDays",7);
    json.UpdateString("AutoVerifiedAttributes[0]","email");
    json.UpdateString("AutoVerifiedAttributes[1]","phone_number");
    json.UpdateString("EmailConfiguration.EmailSendingAccount","DEVELOPER");
    json.UpdateString("EmailConfiguration.From","joe@example.com");
    json.UpdateString("EmailConfiguration.ReplyToEmailAddress","joe@example.com");
    json.UpdateString("EmailConfiguration.SourceArn","arn:aws:ses:us-west-2:954491834127:identity/joe@example.com");
    json.UpdateString("EmailVerificationMessage","Your verification code is {####}. ");
    json.UpdateString("EmailVerificationSubject","Your verification code");
    json.UpdateNewObject("LambdaConfig");
    json.UpdateString("MfaConfiguration","OFF");
    json.UpdateString("PoolName","MyTestPool");
    json.UpdateInt("Policies.PasswordPolicy.MinimumLength",8);
    json.UpdateBool("Policies.PasswordPolicy.RequireLowercase",true);
    json.UpdateBool("Policies.PasswordPolicy.RequireNumbers",true);
    json.UpdateBool("Policies.PasswordPolicy.RequireSymbols",true);
    json.UpdateBool("Policies.PasswordPolicy.RequireUppercase",true);
    json.UpdateInt("Policies.PasswordPolicy.TemporaryPasswordValidityDays",7);
    json.UpdateString("Schema[0].AttributeDataType","String");
    json.UpdateBool("Schema[0].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[0].Mutable",false);
    json.UpdateString("Schema[0].Name","sub");
    json.UpdateBool("Schema[0].Required",true);
    json.UpdateString("Schema[0].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[0].StringAttributeConstraints.MinLength","1");
    json.UpdateString("Schema[1].AttributeDataType","String");
    json.UpdateBool("Schema[1].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[1].Mutable",true);
    json.UpdateString("Schema[1].Name","name");
    json.UpdateBool("Schema[1].Required",false);
    json.UpdateString("Schema[1].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[1].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[2].AttributeDataType","String");
    json.UpdateBool("Schema[2].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[2].Mutable",true);
    json.UpdateString("Schema[2].Name","given_name");
    json.UpdateBool("Schema[2].Required",false);
    json.UpdateString("Schema[2].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[2].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[3].AttributeDataType","String");
    json.UpdateBool("Schema[3].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[3].Mutable",true);
    json.UpdateString("Schema[3].Name","family_name");
    json.UpdateBool("Schema[3].Required",false);
    json.UpdateString("Schema[3].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[3].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[4].AttributeDataType","String");
    json.UpdateBool("Schema[4].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[4].Mutable",true);
    json.UpdateString("Schema[4].Name","middle_name");
    json.UpdateBool("Schema[4].Required",false);
    json.UpdateString("Schema[4].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[4].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[5].AttributeDataType","String");
    json.UpdateBool("Schema[5].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[5].Mutable",true);
    json.UpdateString("Schema[5].Name","nickname");
    json.UpdateBool("Schema[5].Required",false);
    json.UpdateString("Schema[5].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[5].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[6].AttributeDataType","String");
    json.UpdateBool("Schema[6].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[6].Mutable",true);
    json.UpdateString("Schema[6].Name","preferred_username");
    json.UpdateBool("Schema[6].Required",false);
    json.UpdateString("Schema[6].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[6].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[7].AttributeDataType","String");
    json.UpdateBool("Schema[7].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[7].Mutable",true);
    json.UpdateString("Schema[7].Name","profile");
    json.UpdateBool("Schema[7].Required",false);
    json.UpdateString("Schema[7].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[7].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[8].AttributeDataType","String");
    json.UpdateBool("Schema[8].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[8].Mutable",true);
    json.UpdateString("Schema[8].Name","picture");
    json.UpdateBool("Schema[8].Required",false);
    json.UpdateString("Schema[8].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[8].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[9].AttributeDataType","String");
    json.UpdateBool("Schema[9].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[9].Mutable",true);
    json.UpdateString("Schema[9].Name","website");
    json.UpdateBool("Schema[9].Required",false);
    json.UpdateString("Schema[9].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[9].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[10].AttributeDataType","String");
    json.UpdateBool("Schema[10].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[10].Mutable",true);
    json.UpdateString("Schema[10].Name","email");
    json.UpdateBool("Schema[10].Required",true);
    json.UpdateString("Schema[10].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[10].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[11].AttributeDataType","Boolean");
    json.UpdateBool("Schema[11].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[11].Mutable",true);
    json.UpdateString("Schema[11].Name","email_verified");
    json.UpdateBool("Schema[11].Required",false);
    json.UpdateString("Schema[12].AttributeDataType","String");
    json.UpdateBool("Schema[12].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[12].Mutable",true);
    json.UpdateString("Schema[12].Name","gender");
    json.UpdateBool("Schema[12].Required",false);
    json.UpdateString("Schema[12].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[12].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[13].AttributeDataType","String");
    json.UpdateBool("Schema[13].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[13].Mutable",true);
    json.UpdateString("Schema[13].Name","birthdate");
    json.UpdateBool("Schema[13].Required",false);
    json.UpdateString("Schema[13].StringAttributeConstraints.MaxLength","10");
    json.UpdateString("Schema[13].StringAttributeConstraints.MinLength","10");
    json.UpdateString("Schema[14].AttributeDataType","String");
    json.UpdateBool("Schema[14].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[14].Mutable",true);
    json.UpdateString("Schema[14].Name","zoneinfo");
    json.UpdateBool("Schema[14].Required",false);
    json.UpdateString("Schema[14].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[14].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[15].AttributeDataType","String");
    json.UpdateBool("Schema[15].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[15].Mutable",true);
    json.UpdateString("Schema[15].Name","locale");
    json.UpdateBool("Schema[15].Required",false);
    json.UpdateString("Schema[15].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[15].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[16].AttributeDataType","String");
    json.UpdateBool("Schema[16].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[16].Mutable",true);
    json.UpdateString("Schema[16].Name","phone_number");
    json.UpdateBool("Schema[16].Required",false);
    json.UpdateString("Schema[16].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[16].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[17].AttributeDataType","String");
    json.UpdateBool("Schema[17].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[17].Mutable",true);
    json.UpdateString("Schema[17].Name","address");
    json.UpdateBool("Schema[17].Required",false);
    json.UpdateString("Schema[17].StringAttributeConstraints.MaxLength","2048");
    json.UpdateString("Schema[17].StringAttributeConstraints.MinLength","0");
    json.UpdateString("Schema[18].AttributeDataType","Number");
    json.UpdateBool("Schema[18].DeveloperOnlyAttribute",false);
    json.UpdateBool("Schema[18].Mutable",true);
    json.UpdateString("Schema[18].Name","updated_at");
    json.UpdateString("Schema[18].NumberAttributeConstraints.MinValue","0");
    json.UpdateBool("Schema[18].Required",false);
    json.UpdateString("SmsAuthenticationMessage","Your verification code is {####}. ");

    // Use your own value here:
    json.UpdateString("SmsConfiguration.ExternalId","94b17737-216b-4cf7-a29e-17e990e91300");
    json.UpdateString("SmsConfiguration.SnsCallerArn","arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role");

    json.UpdateString("SmsVerificationMessage","Your verification code is {####}. ");
    json.UpdateBool("UsernameConfiguration.CaseSensitive",false);
    json.UpdateString("VerificationMessageTemplate.DefaultEmailOption","CONFIRM_WITH_CODE");
    json.UpdateString("VerificationMessageTemplate.EmailMessage","Your verification code is {####}. ");
    json.UpdateString("VerificationMessageTemplate.EmailSubject","Your verification code");
    json.UpdateString("VerificationMessageTemplate.SmsMessage","Your verification code is {####}. ");

    rest.AddHeader("Content-Type","application/x-amz-json-1.0");
    rest.AddHeader("X-Amz-Target","AWSCognitoIdentityProviderService.CreateUserPool");
    rest.AddHeader("Accept-Encoding","identity");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    console.log("response status code = " + respStatusCode);
    if (respStatusCode !== 200) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    jsonResponse.EmitCompact = false;
    console.log(jsonResponse.Emit());

    // The response is similar to the response at Cognito Describe User Pool

}

chilkatExample();