Lua
Lua
Amazon Cognito - Describe User Pool
See more Amazon Cognito Examples
Returns the configuration information and metadata of the specified user pool.Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local rest = chilkat.Rest.new()
local authAws = chilkat.AuthAws.new()
authAws.access_key = "AWS_ACCESS_KEY"
authAws.secret_key = "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.)
authAws.region = "us-west-2"
authAws.service_name = "cognito-idp"
-- SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest:set_auth_aws(authAws)
-- URL: https://cognito-idp.us-west-2.amazonaws.com/
local bTls = true
local port = 443
local bAutoReconnect = true
-- Use the same region as specified above.
local success = rest:connect("cognito-idp.us-west-2.amazonaws.com", port, bTls, bAutoReconnect)
if not success then
print("ConnectFailReason: " .. rest.connect_fail_reason)
print(rest.last_error_text)
return
end
-- 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.
local json = chilkat.JsonObject.new()
json:update_string("UserPoolId", "us-west-2_yt6WzO3SA")
rest:add_header("Content-Type", "application/x-amz-json-1.0")
rest:add_header("X-Amz-Target", "AWSCognitoIdentityProviderService.DescribeUserPool")
rest:add_header("Accept-Encoding", "identity")
local sbRequestBody = chilkat.StringBuilder.new()
json:emit_sb(sbRequestBody)
local sbResponseBody = chilkat.StringBuilder.new()
success = rest:full_request_sb("POST", "/", sbRequestBody, sbResponseBody)
if not success then
print(rest.last_error_text)
return
end
local respStatusCode = rest.response_status_code
print("response status code = " .. respStatusCode)
if respStatusCode ~= 200 then
print("Response Status Code = " .. respStatusCode)
print("Response Header:")
print(rest.response_header)
print("Response Body:")
print(sbResponseBody:get_as_string())
return
end
local jsonResponse = chilkat.JsonObject.new()
jsonResponse:load_sb(sbResponseBody)
jsonResponse.emit_compact = false
print(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 {####}. "
-- }
-- }
-- }
local Name = ""
local Priority = 0
local strVal = ""
local AttributeDataType = ""
local DeveloperOnlyAttribute = false
local Mutable = false
local Required = false
local StringAttributeConstraintsMaxLength = ""
local StringAttributeConstraintsMinLength = ""
local NumberAttributeConstraintsMinValue = ""
local UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = jsonResponse:bool_of("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly")
local UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = jsonResponse:string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage")
local UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = jsonResponse:string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject")
local UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = jsonResponse:string_of("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage")
local UserPoolAdminCreateUserConfigUnusedAccountValidityDays = jsonResponse:int_of("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays")
local UserPoolArn = jsonResponse:string_of("UserPool.Arn")
local UserPoolCreationDate = jsonResponse:string_of("UserPool.CreationDate")
local UserPoolEmailConfigurationEmailSendingAccount = jsonResponse:string_of("UserPool.EmailConfiguration.EmailSendingAccount")
local UserPoolEmailConfigurationFrom = jsonResponse:string_of("UserPool.EmailConfiguration.From")
local UserPoolEmailConfigurationReplyToEmailAddress = jsonResponse:string_of("UserPool.EmailConfiguration.ReplyToEmailAddress")
local UserPoolEmailConfigurationSourceArn = jsonResponse:string_of("UserPool.EmailConfiguration.SourceArn")
local UserPoolEmailVerificationMessage = jsonResponse:string_of("UserPool.EmailVerificationMessage")
local UserPoolEmailVerificationSubject = jsonResponse:string_of("UserPool.EmailVerificationSubject")
local UserPoolEstimatedNumberOfUsers = jsonResponse:int_of("UserPool.EstimatedNumberOfUsers")
local UserPoolId = jsonResponse:string_of("UserPool.Id")
local UserPoolLastModifiedDate = jsonResponse:string_of("UserPool.LastModifiedDate")
local UserPoolMfaConfiguration = jsonResponse:string_of("UserPool.MfaConfiguration")
local UserPoolName = jsonResponse:string_of("UserPool.Name")
local UserPoolPoliciesPasswordPolicyMinimumLength = jsonResponse:int_of("UserPool.Policies.PasswordPolicy.MinimumLength")
local UserPoolPoliciesPasswordPolicyRequireLowercase = jsonResponse:bool_of("UserPool.Policies.PasswordPolicy.RequireLowercase")
local UserPoolPoliciesPasswordPolicyRequireNumbers = jsonResponse:bool_of("UserPool.Policies.PasswordPolicy.RequireNumbers")
local UserPoolPoliciesPasswordPolicyRequireSymbols = jsonResponse:bool_of("UserPool.Policies.PasswordPolicy.RequireSymbols")
local UserPoolPoliciesPasswordPolicyRequireUppercase = jsonResponse:bool_of("UserPool.Policies.PasswordPolicy.RequireUppercase")
local UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = jsonResponse:int_of("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays")
local UserPoolSmsAuthenticationMessage = jsonResponse:string_of("UserPool.SmsAuthenticationMessage")
local UserPoolSmsConfigurationExternalId = jsonResponse:string_of("UserPool.SmsConfiguration.ExternalId")
local UserPoolSmsConfigurationSnsCallerArn = jsonResponse:string_of("UserPool.SmsConfiguration.SnsCallerArn")
local UserPoolSmsVerificationMessage = jsonResponse:string_of("UserPool.SmsVerificationMessage")
local UserPoolUserPoolTagsSampleUserPoolTag = jsonResponse:string_of("UserPool.UserPoolTags.sampleUserPoolTag")
local UserPoolUsernameConfigurationCaseSensitive = jsonResponse:bool_of("UserPool.UsernameConfiguration.CaseSensitive")
local UserPoolVerificationMessageTemplateDefaultEmailOption = jsonResponse:string_of("UserPool.VerificationMessageTemplate.DefaultEmailOption")
local UserPoolVerificationMessageTemplateEmailMessage = jsonResponse:string_of("UserPool.VerificationMessageTemplate.EmailMessage")
local UserPoolVerificationMessageTemplateEmailSubject = jsonResponse:string_of("UserPool.VerificationMessageTemplate.EmailSubject")
local UserPoolVerificationMessageTemplateSmsMessage = jsonResponse:string_of("UserPool.VerificationMessageTemplate.SmsMessage")
local i = 0
local count_i = jsonResponse:size_of_array("UserPool.AccountRecoverySetting.RecoveryMechanisms")
while i < count_i do
jsonResponse.i = i
Name = jsonResponse:string_of("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name")
Priority = jsonResponse:int_of("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority")
i = i + 1
end
i = 0
count_i = jsonResponse:size_of_array("UserPool.AutoVerifiedAttributes")
while i < count_i do
jsonResponse.i = i
strVal = jsonResponse:string_of("UserPool.AutoVerifiedAttributes[i]")
i = i + 1
end
i = 0
count_i = jsonResponse:size_of_array("UserPool.SchemaAttributes")
while i < count_i do
jsonResponse.i = i
AttributeDataType = jsonResponse:string_of("UserPool.SchemaAttributes[i].AttributeDataType")
DeveloperOnlyAttribute = jsonResponse:bool_of("UserPool.SchemaAttributes[i].DeveloperOnlyAttribute")
Mutable = jsonResponse:bool_of("UserPool.SchemaAttributes[i].Mutable")
Name = jsonResponse:string_of("UserPool.SchemaAttributes[i].Name")
Required = jsonResponse:bool_of("UserPool.SchemaAttributes[i].Required")
StringAttributeConstraintsMaxLength = jsonResponse:string_of("UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength")
StringAttributeConstraintsMinLength = jsonResponse:string_of("UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength")
NumberAttributeConstraintsMinValue = jsonResponse:string_of("UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue")
i = i + 1
end