Tcl
Tcl
Amazon Cognito - Describe User Pool
See more Amazon Cognito Examples
Returns the configuration information and metadata of the specified user pool.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set rest [new_CkRest]
set authAws [new_CkAuthAws]
CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "cognito-idp"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://cognito-idp.us-west-2.amazonaws.com/
set bTls 1
set port 443
set bAutoReconnect 1
# Use the same region as specified above.
set success [CkRest_Connect $rest "cognito-idp.us-west-2.amazonaws.com" $port $bTls $bAutoReconnect]
if {$success != 1} then {
puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
exit
}
# 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.
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "UserPoolId" "us-west-2_yt6WzO3SA"
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.0"
CkRest_AddHeader $rest "X-Amz-Target" "AWSCognitoIdentityProviderService.DescribeUserPool"
CkRest_AddHeader $rest "Accept-Encoding" "identity"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
puts [CkRest_lastErrorText $rest]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
puts "Response Status Code = $respStatusCode"
puts "Response Header:"
puts [CkRest_responseHeader $rest]
puts "Response Body:"
puts [CkStringBuilder_getAsString $sbResponseBody]
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
exit
}
set jsonResponse [new_CkJsonObject]
CkJsonObject_LoadSb $jsonResponse $sbResponseBody
CkJsonObject_put_EmitCompact $jsonResponse 0
puts [CkJsonObject_emit $jsonResponse]
# 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 {####}. "
# }
# }
# }
set UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly [CkJsonObject_BoolOf $jsonResponse "UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly"]
set UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage [CkJsonObject_stringOf $jsonResponse "UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage"]
set UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject [CkJsonObject_stringOf $jsonResponse "UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject"]
set UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage [CkJsonObject_stringOf $jsonResponse "UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage"]
set UserPoolAdminCreateUserConfigUnusedAccountValidityDays [CkJsonObject_IntOf $jsonResponse "UserPool.AdminCreateUserConfig.UnusedAccountValidityDays"]
set UserPoolArn [CkJsonObject_stringOf $jsonResponse "UserPool.Arn"]
set UserPoolCreationDate [CkJsonObject_stringOf $jsonResponse "UserPool.CreationDate"]
set UserPoolEmailConfigurationEmailSendingAccount [CkJsonObject_stringOf $jsonResponse "UserPool.EmailConfiguration.EmailSendingAccount"]
set UserPoolEmailConfigurationFrom [CkJsonObject_stringOf $jsonResponse "UserPool.EmailConfiguration.From"]
set UserPoolEmailConfigurationReplyToEmailAddress [CkJsonObject_stringOf $jsonResponse "UserPool.EmailConfiguration.ReplyToEmailAddress"]
set UserPoolEmailConfigurationSourceArn [CkJsonObject_stringOf $jsonResponse "UserPool.EmailConfiguration.SourceArn"]
set UserPoolEmailVerificationMessage [CkJsonObject_stringOf $jsonResponse "UserPool.EmailVerificationMessage"]
set UserPoolEmailVerificationSubject [CkJsonObject_stringOf $jsonResponse "UserPool.EmailVerificationSubject"]
set UserPoolEstimatedNumberOfUsers [CkJsonObject_IntOf $jsonResponse "UserPool.EstimatedNumberOfUsers"]
set UserPoolId [CkJsonObject_stringOf $jsonResponse "UserPool.Id"]
set UserPoolLastModifiedDate [CkJsonObject_stringOf $jsonResponse "UserPool.LastModifiedDate"]
set UserPoolMfaConfiguration [CkJsonObject_stringOf $jsonResponse "UserPool.MfaConfiguration"]
set UserPoolName [CkJsonObject_stringOf $jsonResponse "UserPool.Name"]
set UserPoolPoliciesPasswordPolicyMinimumLength [CkJsonObject_IntOf $jsonResponse "UserPool.Policies.PasswordPolicy.MinimumLength"]
set UserPoolPoliciesPasswordPolicyRequireLowercase [CkJsonObject_BoolOf $jsonResponse "UserPool.Policies.PasswordPolicy.RequireLowercase"]
set UserPoolPoliciesPasswordPolicyRequireNumbers [CkJsonObject_BoolOf $jsonResponse "UserPool.Policies.PasswordPolicy.RequireNumbers"]
set UserPoolPoliciesPasswordPolicyRequireSymbols [CkJsonObject_BoolOf $jsonResponse "UserPool.Policies.PasswordPolicy.RequireSymbols"]
set UserPoolPoliciesPasswordPolicyRequireUppercase [CkJsonObject_BoolOf $jsonResponse "UserPool.Policies.PasswordPolicy.RequireUppercase"]
set UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays [CkJsonObject_IntOf $jsonResponse "UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays"]
set UserPoolSmsAuthenticationMessage [CkJsonObject_stringOf $jsonResponse "UserPool.SmsAuthenticationMessage"]
set UserPoolSmsConfigurationExternalId [CkJsonObject_stringOf $jsonResponse "UserPool.SmsConfiguration.ExternalId"]
set UserPoolSmsConfigurationSnsCallerArn [CkJsonObject_stringOf $jsonResponse "UserPool.SmsConfiguration.SnsCallerArn"]
set UserPoolSmsVerificationMessage [CkJsonObject_stringOf $jsonResponse "UserPool.SmsVerificationMessage"]
set UserPoolUserPoolTagsSampleUserPoolTag [CkJsonObject_stringOf $jsonResponse "UserPool.UserPoolTags.sampleUserPoolTag"]
set UserPoolUsernameConfigurationCaseSensitive [CkJsonObject_BoolOf $jsonResponse "UserPool.UsernameConfiguration.CaseSensitive"]
set UserPoolVerificationMessageTemplateDefaultEmailOption [CkJsonObject_stringOf $jsonResponse "UserPool.VerificationMessageTemplate.DefaultEmailOption"]
set UserPoolVerificationMessageTemplateEmailMessage [CkJsonObject_stringOf $jsonResponse "UserPool.VerificationMessageTemplate.EmailMessage"]
set UserPoolVerificationMessageTemplateEmailSubject [CkJsonObject_stringOf $jsonResponse "UserPool.VerificationMessageTemplate.EmailSubject"]
set UserPoolVerificationMessageTemplateSmsMessage [CkJsonObject_stringOf $jsonResponse "UserPool.VerificationMessageTemplate.SmsMessage"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "UserPool.AccountRecoverySetting.RecoveryMechanisms"]
while {$i < $count_i} {
CkJsonObject_put_I $jsonResponse $i
set Name [CkJsonObject_stringOf $jsonResponse "UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name"]
set Priority [CkJsonObject_IntOf $jsonResponse "UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "UserPool.AutoVerifiedAttributes"]
while {$i < $count_i} {
CkJsonObject_put_I $jsonResponse $i
set strVal [CkJsonObject_stringOf $jsonResponse "UserPool.AutoVerifiedAttributes[i]"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "UserPool.SchemaAttributes"]
while {$i < $count_i} {
CkJsonObject_put_I $jsonResponse $i
set AttributeDataType [CkJsonObject_stringOf $jsonResponse "UserPool.SchemaAttributes[i].AttributeDataType"]
set DeveloperOnlyAttribute [CkJsonObject_BoolOf $jsonResponse "UserPool.SchemaAttributes[i].DeveloperOnlyAttribute"]
set Mutable [CkJsonObject_BoolOf $jsonResponse "UserPool.SchemaAttributes[i].Mutable"]
set Name [CkJsonObject_stringOf $jsonResponse "UserPool.SchemaAttributes[i].Name"]
set Required [CkJsonObject_BoolOf $jsonResponse "UserPool.SchemaAttributes[i].Required"]
set StringAttributeConstraintsMaxLength [CkJsonObject_stringOf $jsonResponse "UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength"]
set StringAttributeConstraintsMinLength [CkJsonObject_stringOf $jsonResponse "UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength"]
set NumberAttributeConstraintsMinValue [CkJsonObject_stringOf $jsonResponse "UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue"]
set i [expr $i + 1]
}
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse