(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Rest
integer li_Success
oleobject loo_AuthAws
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody
integer li_RespStatusCode
oleobject loo_JsonResponse
string ls_Name
integer li_Priority
string ls_StrVal
string ls_AttributeDataType
integer li_DeveloperOnlyAttribute
integer li_Mutable
integer li_Required
string ls_StringAttributeConstraintsMaxLength
string ls_StringAttributeConstraintsMinLength
string ls_NumberAttributeConstraintsMinValue
integer li_UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly
string ls_UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage
string ls_UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject
string ls_UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage
integer li_UserPoolAdminCreateUserConfigUnusedAccountValidityDays
string ls_UserPoolArn
string ls_UserPoolCreationDate
string ls_UserPoolEmailConfigurationEmailSendingAccount
string ls_UserPoolEmailConfigurationFrom
string ls_UserPoolEmailConfigurationReplyToEmailAddress
string ls_UserPoolEmailConfigurationSourceArn
string ls_UserPoolEmailVerificationMessage
string ls_UserPoolEmailVerificationSubject
integer li_UserPoolEstimatedNumberOfUsers
string ls_UserPoolId
string ls_UserPoolLastModifiedDate
string ls_UserPoolMfaConfiguration
string ls_UserPoolName
integer li_UserPoolPoliciesPasswordPolicyMinimumLength
integer li_UserPoolPoliciesPasswordPolicyRequireLowercase
integer li_UserPoolPoliciesPasswordPolicyRequireNumbers
integer li_UserPoolPoliciesPasswordPolicyRequireSymbols
integer li_UserPoolPoliciesPasswordPolicyRequireUppercase
integer li_UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays
string ls_UserPoolSmsAuthenticationMessage
string ls_UserPoolSmsConfigurationExternalId
string ls_UserPoolSmsConfigurationSnsCallerArn
string ls_UserPoolSmsVerificationMessage
string ls_UserPoolUserPoolTagsSampleUserPoolTag
integer li_UserPoolUsernameConfigurationCaseSensitive
string ls_UserPoolVerificationMessageTemplateDefaultEmailOption
string ls_UserPoolVerificationMessageTemplateEmailMessage
string ls_UserPoolVerificationMessageTemplateEmailSubject
string ls_UserPoolVerificationMessageTemplateSmsMessage
integer i
integer li_Count_i

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

loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_AuthAws = create oleobject
// Use "Chilkat_9_5_0.AuthAws" for versions of Chilkat < 10.0.0
li_rc = loo_AuthAws.ConnectToNewObject("Chilkat.AuthAws")

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

// URL: https://cognito-idp.us-west-2.amazonaws.com/
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
// Use the same region as specified above.
li_Success = loo_Rest.Connect("cognito-idp.us-west-2.amazonaws.com",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug "ConnectFailReason: " + string(loo_Rest.ConnectFailReason)
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    return
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.

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("UserPoolId","us-west-2_yt6WzO3SA")

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

loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbRequestBody)
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestSb("POST","/",loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

li_RespStatusCode = loo_Rest.ResponseStatusCode
Write-Debug "response status code = " + string(li_RespStatusCode)
if li_RespStatusCode <> 200 then
    Write-Debug "Response Status Code = " + string(li_RespStatusCode)
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug "Response Body:"
    Write-Debug loo_SbResponseBody.GetAsString()
    destroy loo_Rest
    destroy loo_AuthAws
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    return
end if

loo_JsonResponse = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonResponse.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonResponse.LoadSb(loo_SbResponseBody)

loo_JsonResponse.EmitCompact = 0
Write-Debug loo_JsonResponse.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 {####}. "
//     }
//   }
// }

li_UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = loo_JsonResponse.BoolOf("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly")
ls_UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = loo_JsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage")
ls_UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = loo_JsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject")
ls_UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = loo_JsonResponse.StringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage")
li_UserPoolAdminCreateUserConfigUnusedAccountValidityDays = loo_JsonResponse.IntOf("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays")
ls_UserPoolArn = loo_JsonResponse.StringOf("UserPool.Arn")
ls_UserPoolCreationDate = loo_JsonResponse.StringOf("UserPool.CreationDate")
ls_UserPoolEmailConfigurationEmailSendingAccount = loo_JsonResponse.StringOf("UserPool.EmailConfiguration.EmailSendingAccount")
ls_UserPoolEmailConfigurationFrom = loo_JsonResponse.StringOf("UserPool.EmailConfiguration.From")
ls_UserPoolEmailConfigurationReplyToEmailAddress = loo_JsonResponse.StringOf("UserPool.EmailConfiguration.ReplyToEmailAddress")
ls_UserPoolEmailConfigurationSourceArn = loo_JsonResponse.StringOf("UserPool.EmailConfiguration.SourceArn")
ls_UserPoolEmailVerificationMessage = loo_JsonResponse.StringOf("UserPool.EmailVerificationMessage")
ls_UserPoolEmailVerificationSubject = loo_JsonResponse.StringOf("UserPool.EmailVerificationSubject")
li_UserPoolEstimatedNumberOfUsers = loo_JsonResponse.IntOf("UserPool.EstimatedNumberOfUsers")
ls_UserPoolId = loo_JsonResponse.StringOf("UserPool.Id")
ls_UserPoolLastModifiedDate = loo_JsonResponse.StringOf("UserPool.LastModifiedDate")
ls_UserPoolMfaConfiguration = loo_JsonResponse.StringOf("UserPool.MfaConfiguration")
ls_UserPoolName = loo_JsonResponse.StringOf("UserPool.Name")
li_UserPoolPoliciesPasswordPolicyMinimumLength = loo_JsonResponse.IntOf("UserPool.Policies.PasswordPolicy.MinimumLength")
li_UserPoolPoliciesPasswordPolicyRequireLowercase = loo_JsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireLowercase")
li_UserPoolPoliciesPasswordPolicyRequireNumbers = loo_JsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireNumbers")
li_UserPoolPoliciesPasswordPolicyRequireSymbols = loo_JsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireSymbols")
li_UserPoolPoliciesPasswordPolicyRequireUppercase = loo_JsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireUppercase")
li_UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = loo_JsonResponse.IntOf("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays")
ls_UserPoolSmsAuthenticationMessage = loo_JsonResponse.StringOf("UserPool.SmsAuthenticationMessage")
ls_UserPoolSmsConfigurationExternalId = loo_JsonResponse.StringOf("UserPool.SmsConfiguration.ExternalId")
ls_UserPoolSmsConfigurationSnsCallerArn = loo_JsonResponse.StringOf("UserPool.SmsConfiguration.SnsCallerArn")
ls_UserPoolSmsVerificationMessage = loo_JsonResponse.StringOf("UserPool.SmsVerificationMessage")
ls_UserPoolUserPoolTagsSampleUserPoolTag = loo_JsonResponse.StringOf("UserPool.UserPoolTags.sampleUserPoolTag")
li_UserPoolUsernameConfigurationCaseSensitive = loo_JsonResponse.BoolOf("UserPool.UsernameConfiguration.CaseSensitive")
ls_UserPoolVerificationMessageTemplateDefaultEmailOption = loo_JsonResponse.StringOf("UserPool.VerificationMessageTemplate.DefaultEmailOption")
ls_UserPoolVerificationMessageTemplateEmailMessage = loo_JsonResponse.StringOf("UserPool.VerificationMessageTemplate.EmailMessage")
ls_UserPoolVerificationMessageTemplateEmailSubject = loo_JsonResponse.StringOf("UserPool.VerificationMessageTemplate.EmailSubject")
ls_UserPoolVerificationMessageTemplateSmsMessage = loo_JsonResponse.StringOf("UserPool.VerificationMessageTemplate.SmsMessage")

i = 0
li_Count_i = loo_JsonResponse.SizeOfArray("UserPool.AccountRecoverySetting.RecoveryMechanisms")
do while i < li_Count_i
    loo_JsonResponse.I = i
    ls_Name = loo_JsonResponse.StringOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name")
    li_Priority = loo_JsonResponse.IntOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority")
    i = i + 1
loop

i = 0
li_Count_i = loo_JsonResponse.SizeOfArray("UserPool.AutoVerifiedAttributes")
do while i < li_Count_i
    loo_JsonResponse.I = i
    ls_StrVal = loo_JsonResponse.StringOf("UserPool.AutoVerifiedAttributes[i]")
    i = i + 1
loop

i = 0
li_Count_i = loo_JsonResponse.SizeOfArray("UserPool.SchemaAttributes")
do while i < li_Count_i
    loo_JsonResponse.I = i
    ls_AttributeDataType = loo_JsonResponse.StringOf("UserPool.SchemaAttributes[i].AttributeDataType")
    li_DeveloperOnlyAttribute = loo_JsonResponse.BoolOf("UserPool.SchemaAttributes[i].DeveloperOnlyAttribute")
    li_Mutable = loo_JsonResponse.BoolOf("UserPool.SchemaAttributes[i].Mutable")
    ls_Name = loo_JsonResponse.StringOf("UserPool.SchemaAttributes[i].Name")
    li_Required = loo_JsonResponse.BoolOf("UserPool.SchemaAttributes[i].Required")
    ls_StringAttributeConstraintsMaxLength = loo_JsonResponse.StringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength")
    ls_StringAttributeConstraintsMinLength = loo_JsonResponse.StringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength")
    ls_NumberAttributeConstraintsMinValue = loo_JsonResponse.StringOf("UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue")
    i = i + 1
loop


destroy loo_Rest
destroy loo_AuthAws
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JsonResponse