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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loRest = createobject("CkRest")

loAuthAws = createobject("CkAuthAws")
loAuthAws.AccessKey = "AWS_ACCESS_KEY"
loAuthAws.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.)
loAuthAws.Region = "us-west-2"
loAuthAws.ServiceName = "cognito-idp"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
loRest.SetAuthAws(loAuthAws)

// URL: https://cognito-idp.us-west-2.amazonaws.com/
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
// Use the same region as specified above.
llSuccess = loRest.Connect("cognito-idp.us-west-2.amazonaws.com",lnPort,llBTls,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? "ConnectFailReason: " + str(loRest.ConnectFailReason)
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    return
endif

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

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

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

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

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestSb("POST","/",loSbRequestBody,loSbResponseBody)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    return
endif

lnRespStatusCode = loRest.ResponseStatusCode
? "response status code = " + str(lnRespStatusCode)
if (lnRespStatusCode <> 200) then
    ? "Response Status Code = " + str(lnRespStatusCode)
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? loSbResponseBody.GetAsString()
    release loRest
    release loAuthAws
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    return
endif

loJsonResponse = createobject("CkJsonObject")
loJsonResponse.LoadSb(loSbResponseBody)

loJsonResponse.EmitCompact = .F.
? loJsonResponse.Emit()

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


release loRest
release loAuthAws
release loJson
release loSbRequestBody
release loSbResponseBody
release loJsonResponse