(Lianja) Amazon Cognito - Describe User Pool

See more Amazon Cognito Examples

Returns the configuration information and metadata of the specified user pool.

For more information, see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.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.

loJson = createobject("CkJsonObject")
loJson.UpdateString("UserPoolId","us-west-2_yt6WzO3SA")

loRest.AddHeader("Content-Type","application/x-amz-json-1.0")
loRest.AddHeader("X-Amz-Target","AWSCognitoIdentityProviderService.DescribeUserPool")
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()

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

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

// {
//   "UserPool": {
//     "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 {####}. "
//       },
//       "UnusedAccountValidityDays": 7
//     },
//     "Arn": "arn:aws:cognito-idp:us-west-2:954491834127:userpool/us-west-2_yt6WzO3SA",
//     "AutoVerifiedAttributes": [
//       "email",
//       "phone_number"
//     ],
//     "CreationDate": 1.636388909817E9,
//     "EmailConfiguration": {
//       "EmailSendingAccount": "DEVELOPER",
//       "From": "admin@chilkatsoft.com",
//       "ReplyToEmailAddress": "admin@chilkatsoft.com",
//       "SourceArn": "arn:aws:ses:us-west-2:954491834127:identity/admin@chilkatsoft.com"
//     },
//     "EmailVerificationMessage": "Your verification code is {####}. ",
//     "EmailVerificationSubject": "Your verification code",
//     "EstimatedNumberOfUsers": 0,
//     "Id": "us-west-2_yt6WzO3SA",
//     "LambdaConfig": {},
//     "LastModifiedDate": 1.636388910377E9,
//     "MfaConfiguration": "ON",
//     "Name": "chilkat",
//     "Policies": {
//       "PasswordPolicy": {
//         "MinimumLength": 8,
//         "RequireLowercase": true,
//         "RequireNumbers": true,
//         "RequireSymbols": true,
//         "RequireUppercase": true,
//         "TemporaryPasswordValidityDays": 7
//       }
//     },
//     "SchemaAttributes": [
//       {
//         "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": "Boolean",
//         "DeveloperOnlyAttribute": false,
//         "Mutable": true,
//         "Name": "phone_number_verified",
//         "Required": false
//       },
//       {
//         "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 {####}. ",
//     "UserPoolTags": {
//       "sampleUserPoolTag": "test"
//     },
//     "UsernameConfiguration": {
//       "CaseSensitive": false
//     },
//     "VerificationMessageTemplate": {
//       "DefaultEmailOption": "CONFIRM_WITH_CODE",
//       "EmailMessage": "Your verification code is {####}. ",
//       "EmailSubject": "Your verification code",
//       "SmsMessage": "Your verification code is {####}. "
//     }
//   }
// }

llUserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = loJsonResponse.BoolOf("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly")
lcUserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = loJsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage")
lcUserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = loJsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject")
lcUserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = loJsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage")
lnUserPoolAdminCreateUserConfigUnusedAccountValidityDays = loJsonResponse.IntOf("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays")
lcUserPoolArn = loJsonResponse.StringOf("UserPool.Arn")
lcUserPoolCreationDate = loJsonResponse.StringOf("UserPool.CreationDate")
lcUserPoolEmailConfigurationEmailSendingAccount = loJsonResponse.StringOf("UserPool.EmailConfiguration.EmailSendingAccount")
lcUserPoolEmailConfigurationFrom = loJsonResponse.StringOf("UserPool.EmailConfiguration.From")
lcUserPoolEmailConfigurationReplyToEmailAddress = loJsonResponse.StringOf("UserPool.EmailConfiguration.ReplyToEmailAddress")
lcUserPoolEmailConfigurationSourceArn = loJsonResponse.StringOf("UserPool.EmailConfiguration.SourceArn")
lcUserPoolEmailVerificationMessage = loJsonResponse.StringOf("UserPool.EmailVerificationMessage")
lcUserPoolEmailVerificationSubject = loJsonResponse.StringOf("UserPool.EmailVerificationSubject")
lnUserPoolEstimatedNumberOfUsers = loJsonResponse.IntOf("UserPool.EstimatedNumberOfUsers")
lcUserPoolId = loJsonResponse.StringOf("UserPool.Id")
lcUserPoolLastModifiedDate = loJsonResponse.StringOf("UserPool.LastModifiedDate")
lcUserPoolMfaConfiguration = loJsonResponse.StringOf("UserPool.MfaConfiguration")
lcUserPoolName = loJsonResponse.StringOf("UserPool.Name")
lnUserPoolPoliciesPasswordPolicyMinimumLength = loJsonResponse.IntOf("UserPool.Policies.PasswordPolicy.MinimumLength")
llUserPoolPoliciesPasswordPolicyRequireLowercase = loJsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireLowercase")
llUserPoolPoliciesPasswordPolicyRequireNumbers = loJsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireNumbers")
llUserPoolPoliciesPasswordPolicyRequireSymbols = loJsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireSymbols")
llUserPoolPoliciesPasswordPolicyRequireUppercase = loJsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireUppercase")
lnUserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = loJsonResponse.IntOf("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays")
lcUserPoolSmsAuthenticationMessage = loJsonResponse.StringOf("UserPool.SmsAuthenticationMessage")
lcUserPoolSmsConfigurationExternalId = loJsonResponse.StringOf("UserPool.SmsConfiguration.ExternalId")
lcUserPoolSmsConfigurationSnsCallerArn = loJsonResponse.StringOf("UserPool.SmsConfiguration.SnsCallerArn")
lcUserPoolSmsVerificationMessage = loJsonResponse.StringOf("UserPool.SmsVerificationMessage")
lcUserPoolUserPoolTagsSampleUserPoolTag = loJsonResponse.StringOf("UserPool.UserPoolTags.sampleUserPoolTag")
llUserPoolUsernameConfigurationCaseSensitive = loJsonResponse.BoolOf("UserPool.UsernameConfiguration.CaseSensitive")
lcUserPoolVerificationMessageTemplateDefaultEmailOption = loJsonResponse.StringOf("UserPool.VerificationMessageTemplate.DefaultEmailOption")
lcUserPoolVerificationMessageTemplateEmailMessage = loJsonResponse.StringOf("UserPool.VerificationMessageTemplate.EmailMessage")
lcUserPoolVerificationMessageTemplateEmailSubject = loJsonResponse.StringOf("UserPool.VerificationMessageTemplate.EmailSubject")
lcUserPoolVerificationMessageTemplateSmsMessage = loJsonResponse.StringOf("UserPool.VerificationMessageTemplate.SmsMessage")

i = 0
lnCount_i = loJsonResponse.SizeOfArray("UserPool.AccountRecoverySetting.RecoveryMechanisms")
do while i < lnCount_i
    loJsonResponse.I = i
    lcName = loJsonResponse.StringOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name")
    lnPriority = loJsonResponse.IntOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority")
    i = i + 1
enddo

i = 0
lnCount_i = loJsonResponse.SizeOfArray("UserPool.AutoVerifiedAttributes")
do while i < lnCount_i
    loJsonResponse.I = i
    lcStrVal = loJsonResponse.StringOf("UserPool.AutoVerifiedAttributes[i]")
    i = i + 1
enddo

i = 0
lnCount_i = loJsonResponse.SizeOfArray("UserPool.SchemaAttributes")
do while i < lnCount_i
    loJsonResponse.I = i
    lcAttributeDataType = loJsonResponse.StringOf("UserPool.SchemaAttributes[i].AttributeDataType")
    llDeveloperOnlyAttribute = loJsonResponse.BoolOf("UserPool.SchemaAttributes[i].DeveloperOnlyAttribute")
    llMutable = loJsonResponse.BoolOf("UserPool.SchemaAttributes[i].Mutable")
    lcName = loJsonResponse.StringOf("UserPool.SchemaAttributes[i].Name")
    llRequired = loJsonResponse.BoolOf("UserPool.SchemaAttributes[i].Required")
    lcStringAttributeConstraintsMaxLength = loJsonResponse.StringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength")
    lcStringAttributeConstraintsMinLength = loJsonResponse.StringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength")
    lcNumberAttributeConstraintsMinValue = loJsonResponse.StringOf("UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue")
    i = i + 1
enddo


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