Xbase++
Xbase++
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.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oRest
LOCAL oAuthAws
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oJson
LOCAL oSbRequestBody
LOCAL oSbResponseBody
LOCAL nRespStatusCode
LOCAL oJsonResponse
nSuccess := 0
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oRest := CreateObject("Chilkat.Rest")
oAuthAws := CreateObject("Chilkat.AuthAws")
oAuthAws:AccessKey := "AWS_ACCESS_KEY"
oAuthAws: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.)
oAuthAws:Region := "us-west-2"
oAuthAws:ServiceName := "cognito-idp"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
oRest:SetAuthAws(oAuthAws)
// URL: https://cognito-idp.us-west-2.amazonaws.com/
nBTls := 1
nPort := 443
nBAutoReconnect := 1
// Use the same region as specified above.
nSuccess := oRest:Connect("cognito-idp.us-west-2.amazonaws.com", nPort, nBTls, nBAutoReconnect)
IF (nSuccess != 1)
? "ConnectFailReason: " + Str(oRest:ConnectFailReason)
? oRest:LastErrorText
oRest:destroy()
oAuthAws:destroy()
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 {####}. "
// }
// }
//
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("AccountRecoverySetting.RecoveryMechanisms[0].Name", "verified_phone_number")
oJson:UpdateInt("AccountRecoverySetting.RecoveryMechanisms[0].Priority", 1)
oJson:UpdateString("AccountRecoverySetting.RecoveryMechanisms[1].Name", "verified_email")
oJson:UpdateInt("AccountRecoverySetting.RecoveryMechanisms[1].Priority", 2)
oJson:UpdateBool("AdminCreateUserConfig.AllowAdminCreateUserOnly", 0)
oJson:UpdateString("AdminCreateUserConfig.InviteMessageTemplate.EmailMessage", "Your username is {username} and temporary password is {####}. ")
oJson:UpdateString("AdminCreateUserConfig.InviteMessageTemplate.EmailSubject", "Your temporary password")
oJson:UpdateString("AdminCreateUserConfig.InviteMessageTemplate.SMSMessage", "Your username is {username} and temporary password is {####}. ")
oJson:UpdateInt("AdminCreateUserConfig.TemporaryPasswordValidityDays", 7)
oJson:UpdateString("AutoVerifiedAttributes[0]", "email")
oJson:UpdateString("AutoVerifiedAttributes[1]", "phone_number")
oJson:UpdateString("EmailConfiguration.EmailSendingAccount", "DEVELOPER")
oJson:UpdateString("EmailConfiguration.From", "joe@example.com")
oJson:UpdateString("EmailConfiguration.ReplyToEmailAddress", "joe@example.com")
oJson:UpdateString("EmailConfiguration.SourceArn", "arn:aws:ses:us-west-2:954491834127:identity/joe@example.com")
oJson:UpdateString("EmailVerificationMessage", "Your verification code is {####}. ")
oJson:UpdateString("EmailVerificationSubject", "Your verification code")
oJson:UpdateNewObject("LambdaConfig")
oJson:UpdateString("MfaConfiguration", "OFF")
oJson:UpdateString("PoolName", "MyTestPool")
oJson:UpdateInt("Policies.PasswordPolicy.MinimumLength", 8)
oJson:UpdateBool("Policies.PasswordPolicy.RequireLowercase", 1)
oJson:UpdateBool("Policies.PasswordPolicy.RequireNumbers", 1)
oJson:UpdateBool("Policies.PasswordPolicy.RequireSymbols", 1)
oJson:UpdateBool("Policies.PasswordPolicy.RequireUppercase", 1)
oJson:UpdateInt("Policies.PasswordPolicy.TemporaryPasswordValidityDays", 7)
oJson:UpdateString("Schema[0].AttributeDataType", "String")
oJson:UpdateBool("Schema[0].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[0].Mutable", 0)
oJson:UpdateString("Schema[0].Name", "sub")
oJson:UpdateBool("Schema[0].Required", 1)
oJson:UpdateString("Schema[0].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[0].StringAttributeConstraints.MinLength", "1")
oJson:UpdateString("Schema[1].AttributeDataType", "String")
oJson:UpdateBool("Schema[1].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[1].Mutable", 1)
oJson:UpdateString("Schema[1].Name", "name")
oJson:UpdateBool("Schema[1].Required", 0)
oJson:UpdateString("Schema[1].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[1].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[2].AttributeDataType", "String")
oJson:UpdateBool("Schema[2].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[2].Mutable", 1)
oJson:UpdateString("Schema[2].Name", "given_name")
oJson:UpdateBool("Schema[2].Required", 0)
oJson:UpdateString("Schema[2].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[2].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[3].AttributeDataType", "String")
oJson:UpdateBool("Schema[3].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[3].Mutable", 1)
oJson:UpdateString("Schema[3].Name", "family_name")
oJson:UpdateBool("Schema[3].Required", 0)
oJson:UpdateString("Schema[3].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[3].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[4].AttributeDataType", "String")
oJson:UpdateBool("Schema[4].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[4].Mutable", 1)
oJson:UpdateString("Schema[4].Name", "middle_name")
oJson:UpdateBool("Schema[4].Required", 0)
oJson:UpdateString("Schema[4].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[4].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[5].AttributeDataType", "String")
oJson:UpdateBool("Schema[5].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[5].Mutable", 1)
oJson:UpdateString("Schema[5].Name", "nickname")
oJson:UpdateBool("Schema[5].Required", 0)
oJson:UpdateString("Schema[5].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[5].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[6].AttributeDataType", "String")
oJson:UpdateBool("Schema[6].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[6].Mutable", 1)
oJson:UpdateString("Schema[6].Name", "preferred_username")
oJson:UpdateBool("Schema[6].Required", 0)
oJson:UpdateString("Schema[6].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[6].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[7].AttributeDataType", "String")
oJson:UpdateBool("Schema[7].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[7].Mutable", 1)
oJson:UpdateString("Schema[7].Name", "profile")
oJson:UpdateBool("Schema[7].Required", 0)
oJson:UpdateString("Schema[7].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[7].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[8].AttributeDataType", "String")
oJson:UpdateBool("Schema[8].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[8].Mutable", 1)
oJson:UpdateString("Schema[8].Name", "picture")
oJson:UpdateBool("Schema[8].Required", 0)
oJson:UpdateString("Schema[8].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[8].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[9].AttributeDataType", "String")
oJson:UpdateBool("Schema[9].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[9].Mutable", 1)
oJson:UpdateString("Schema[9].Name", "website")
oJson:UpdateBool("Schema[9].Required", 0)
oJson:UpdateString("Schema[9].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[9].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[10].AttributeDataType", "String")
oJson:UpdateBool("Schema[10].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[10].Mutable", 1)
oJson:UpdateString("Schema[10].Name", "email")
oJson:UpdateBool("Schema[10].Required", 1)
oJson:UpdateString("Schema[10].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[10].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[11].AttributeDataType", "Boolean")
oJson:UpdateBool("Schema[11].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[11].Mutable", 1)
oJson:UpdateString("Schema[11].Name", "email_verified")
oJson:UpdateBool("Schema[11].Required", 0)
oJson:UpdateString("Schema[12].AttributeDataType", "String")
oJson:UpdateBool("Schema[12].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[12].Mutable", 1)
oJson:UpdateString("Schema[12].Name", "gender")
oJson:UpdateBool("Schema[12].Required", 0)
oJson:UpdateString("Schema[12].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[12].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[13].AttributeDataType", "String")
oJson:UpdateBool("Schema[13].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[13].Mutable", 1)
oJson:UpdateString("Schema[13].Name", "birthdate")
oJson:UpdateBool("Schema[13].Required", 0)
oJson:UpdateString("Schema[13].StringAttributeConstraints.MaxLength", "10")
oJson:UpdateString("Schema[13].StringAttributeConstraints.MinLength", "10")
oJson:UpdateString("Schema[14].AttributeDataType", "String")
oJson:UpdateBool("Schema[14].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[14].Mutable", 1)
oJson:UpdateString("Schema[14].Name", "zoneinfo")
oJson:UpdateBool("Schema[14].Required", 0)
oJson:UpdateString("Schema[14].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[14].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[15].AttributeDataType", "String")
oJson:UpdateBool("Schema[15].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[15].Mutable", 1)
oJson:UpdateString("Schema[15].Name", "locale")
oJson:UpdateBool("Schema[15].Required", 0)
oJson:UpdateString("Schema[15].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[15].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[16].AttributeDataType", "String")
oJson:UpdateBool("Schema[16].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[16].Mutable", 1)
oJson:UpdateString("Schema[16].Name", "phone_number")
oJson:UpdateBool("Schema[16].Required", 0)
oJson:UpdateString("Schema[16].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[16].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[17].AttributeDataType", "String")
oJson:UpdateBool("Schema[17].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[17].Mutable", 1)
oJson:UpdateString("Schema[17].Name", "address")
oJson:UpdateBool("Schema[17].Required", 0)
oJson:UpdateString("Schema[17].StringAttributeConstraints.MaxLength", "2048")
oJson:UpdateString("Schema[17].StringAttributeConstraints.MinLength", "0")
oJson:UpdateString("Schema[18].AttributeDataType", "Number")
oJson:UpdateBool("Schema[18].DeveloperOnlyAttribute", 0)
oJson:UpdateBool("Schema[18].Mutable", 1)
oJson:UpdateString("Schema[18].Name", "updated_at")
oJson:UpdateString("Schema[18].NumberAttributeConstraints.MinValue", "0")
oJson:UpdateBool("Schema[18].Required", 0)
oJson:UpdateString("SmsAuthenticationMessage", "Your verification code is {####}. ")
// Use your own value here:
oJson:UpdateString("SmsConfiguration.ExternalId", "94b17737-216b-4cf7-a29e-17e990e91300")
oJson:UpdateString("SmsConfiguration.SnsCallerArn", "arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role")
oJson:UpdateString("SmsVerificationMessage", "Your verification code is {####}. ")
oJson:UpdateBool("UsernameConfiguration.CaseSensitive", 0)
oJson:UpdateString("VerificationMessageTemplate.DefaultEmailOption", "CONFIRM_WITH_CODE")
oJson:UpdateString("VerificationMessageTemplate.EmailMessage", "Your verification code is {####}. ")
oJson:UpdateString("VerificationMessageTemplate.EmailSubject", "Your verification code")
oJson:UpdateString("VerificationMessageTemplate.SmsMessage", "Your verification code is {####}. ")
oRest:AddHeader("Content-Type", "application/x-amz-json-1.0")
oRest:AddHeader("X-Amz-Target", "AWSCognitoIdentityProviderService.CreateUserPool")
oRest:AddHeader("Accept-Encoding", "identity")
oSbRequestBody := CreateObject("Chilkat.StringBuilder")
oJson:EmitSb(oSbRequestBody)
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestSb("POST", "/", oSbRequestBody, oSbResponseBody)
IF (nSuccess != 1)
? oRest:LastErrorText
oRest:destroy()
oAuthAws:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
RETURN
ENDIF
nRespStatusCode := oRest:ResponseStatusCode
? "response status code = " + Str(nRespStatusCode)
IF (nRespStatusCode != 200)
? "Response Status Code = " + Str(nRespStatusCode)
? "Response Header:"
? oRest:ResponseHeader
? "Response Body:"
? oSbResponseBody:GetAsString()
oRest:destroy()
oAuthAws:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
RETURN
ENDIF
oJsonResponse := CreateObject("Chilkat.JsonObject")
oJsonResponse:LoadSb(oSbResponseBody)
oJsonResponse:EmitCompact := 0
? oJsonResponse:Emit()
// The response is similar to the response at Cognito Describe User Pool
oRest:destroy()
oAuthAws:destroy()
oJson:destroy()
oSbRequestBody:destroy()
oSbResponseBody:destroy()
oJsonResponse:destroy()