(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

Dim authAws As Chilkat.AuthAws
Set authAws = Chilkat.NewAuthAws
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
Dim success As Boolean
success = rest.SetAuthAws(authAws)

' URL: https://cognito-idp.us-west-2.amazonaws.com/

bTls = True

port = 443

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) Then
    Debug.Print "ConnectFailReason: "; rest.ConnectFailReason
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' 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 {####}. "
'     }
'   }
' 

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

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

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

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

Dim sbRequestBody As Chilkat.StringBuilder
Set sbRequestBody = Chilkat.NewStringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If


respStatusCode = rest.ResponseStatusCode
Debug.Print "response status code = "; respStatusCode
If (respStatusCode <> 200) Then
    Debug.Print "Response Status Code = "; respStatusCode
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print "Response Body:"
    Debug.Print sbResponseBody.GetAsString()
    Exit Sub
End If

Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
success = jsonResponse.LoadSb(sbResponseBody)

jsonResponse.EmitCompact = False
Debug.Print jsonResponse.Emit()

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