|
Chilkat • HOME • .NET Core C# • Android™ • AutoIt • C • C# • C++ • Chilkat2-Python • CkPython • Classic ASP • DataFlex • Delphi ActiveX • Delphi DLL • Go • Java • Lianja • Mono C# • Node.js • Objective-C • PHP ActiveX • PHP Extension • Perl • PowerBuilder • PowerShell • PureBasic • Ruby • SQL Server • Swift 2 • Swift 3,4,5... • Tcl • Unicode C • Unicode C++ • VB.NET • VBScript • Visual Basic 6.0 • Visual FoxPro • Xojo Plugin
(Perl) Amazon Cognito - Describe User PoolSee more Amazon Cognito ExamplesReturns 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
use chilkat(); # This example requires the Chilkat API to have been previously unlocked. # See Global Unlock Sample for sample code. $rest = chilkat::CkRest->new(); $authAws = chilkat::CkAuthAws->new(); $authAws->put_AccessKey("AWS_ACCESS_KEY"); $authAws->put_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.) $authAws->put_Region("us-west-2"); $authAws->put_ServiceName("cognito-idp"); # SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date $rest->SetAuthAws($authAws); # URL: https://cognito-idp.us-west-2.amazonaws.com/ $bTls = 1; $port = 443; $bAutoReconnect = 1; # Use the same region as specified above. $success = $rest->Connect("cognito-idp.us-west-2.amazonaws.com",$port,$bTls,$bAutoReconnect); if ($success != 1) { print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n"; print $rest->lastErrorText() . "\r\n"; 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. $json = chilkat::CkJsonObject->new(); $json->UpdateString("UserPoolId","us-west-2_yt6WzO3SA"); $rest->AddHeader("Content-Type","application/x-amz-json-1.0"); $rest->AddHeader("X-Amz-Target","AWSCognitoIdentityProviderService.DescribeUserPool"); $rest->AddHeader("Accept-Encoding","identity"); $sbRequestBody = chilkat::CkStringBuilder->new(); $json->EmitSb($sbRequestBody); $sbResponseBody = chilkat::CkStringBuilder->new(); $success = $rest->FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody); if ($success != 1) { print $rest->lastErrorText() . "\r\n"; exit; } $respStatusCode = $rest->get_ResponseStatusCode(); print "response status code = " . $respStatusCode . "\r\n"; if ($respStatusCode != 200) { print "Response Status Code = " . $respStatusCode . "\r\n"; print "Response Header:" . "\r\n"; print $rest->responseHeader() . "\r\n"; print "Response Body:" . "\r\n"; print $sbResponseBody->getAsString() . "\r\n"; exit; } $jsonResponse = chilkat::CkJsonObject->new(); $jsonResponse->LoadSb($sbResponseBody); $jsonResponse->put_EmitCompact(0); print $jsonResponse->emit() . "\r\n"; # 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 {####}. " # } # } # } $UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = $jsonResponse->BoolOf("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly"); $UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = $jsonResponse->stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage"); $UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = $jsonResponse->stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject"); $UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = $jsonResponse->stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage"); $UserPoolAdminCreateUserConfigUnusedAccountValidityDays = $jsonResponse->IntOf("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays"); $UserPoolArn = $jsonResponse->stringOf("UserPool.Arn"); $UserPoolCreationDate = $jsonResponse->stringOf("UserPool.CreationDate"); $UserPoolEmailConfigurationEmailSendingAccount = $jsonResponse->stringOf("UserPool.EmailConfiguration.EmailSendingAccount"); $UserPoolEmailConfigurationFrom = $jsonResponse->stringOf("UserPool.EmailConfiguration.From"); $UserPoolEmailConfigurationReplyToEmailAddress = $jsonResponse->stringOf("UserPool.EmailConfiguration.ReplyToEmailAddress"); $UserPoolEmailConfigurationSourceArn = $jsonResponse->stringOf("UserPool.EmailConfiguration.SourceArn"); $UserPoolEmailVerificationMessage = $jsonResponse->stringOf("UserPool.EmailVerificationMessage"); $UserPoolEmailVerificationSubject = $jsonResponse->stringOf("UserPool.EmailVerificationSubject"); $UserPoolEstimatedNumberOfUsers = $jsonResponse->IntOf("UserPool.EstimatedNumberOfUsers"); $UserPoolId = $jsonResponse->stringOf("UserPool.Id"); $UserPoolLastModifiedDate = $jsonResponse->stringOf("UserPool.LastModifiedDate"); $UserPoolMfaConfiguration = $jsonResponse->stringOf("UserPool.MfaConfiguration"); $UserPoolName = $jsonResponse->stringOf("UserPool.Name"); $UserPoolPoliciesPasswordPolicyMinimumLength = $jsonResponse->IntOf("UserPool.Policies.PasswordPolicy.MinimumLength"); $UserPoolPoliciesPasswordPolicyRequireLowercase = $jsonResponse->BoolOf("UserPool.Policies.PasswordPolicy.RequireLowercase"); $UserPoolPoliciesPasswordPolicyRequireNumbers = $jsonResponse->BoolOf("UserPool.Policies.PasswordPolicy.RequireNumbers"); $UserPoolPoliciesPasswordPolicyRequireSymbols = $jsonResponse->BoolOf("UserPool.Policies.PasswordPolicy.RequireSymbols"); $UserPoolPoliciesPasswordPolicyRequireUppercase = $jsonResponse->BoolOf("UserPool.Policies.PasswordPolicy.RequireUppercase"); $UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = $jsonResponse->IntOf("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays"); $UserPoolSmsAuthenticationMessage = $jsonResponse->stringOf("UserPool.SmsAuthenticationMessage"); $UserPoolSmsConfigurationExternalId = $jsonResponse->stringOf("UserPool.SmsConfiguration.ExternalId"); $UserPoolSmsConfigurationSnsCallerArn = $jsonResponse->stringOf("UserPool.SmsConfiguration.SnsCallerArn"); $UserPoolSmsVerificationMessage = $jsonResponse->stringOf("UserPool.SmsVerificationMessage"); $UserPoolUserPoolTagsSampleUserPoolTag = $jsonResponse->stringOf("UserPool.UserPoolTags.sampleUserPoolTag"); $UserPoolUsernameConfigurationCaseSensitive = $jsonResponse->BoolOf("UserPool.UsernameConfiguration.CaseSensitive"); $UserPoolVerificationMessageTemplateDefaultEmailOption = $jsonResponse->stringOf("UserPool.VerificationMessageTemplate.DefaultEmailOption"); $UserPoolVerificationMessageTemplateEmailMessage = $jsonResponse->stringOf("UserPool.VerificationMessageTemplate.EmailMessage"); $UserPoolVerificationMessageTemplateEmailSubject = $jsonResponse->stringOf("UserPool.VerificationMessageTemplate.EmailSubject"); $UserPoolVerificationMessageTemplateSmsMessage = $jsonResponse->stringOf("UserPool.VerificationMessageTemplate.SmsMessage"); $i = 0; $count_i = $jsonResponse->SizeOfArray("UserPool.AccountRecoverySetting.RecoveryMechanisms"); while ($i < $count_i) { $jsonResponse->put_I($i); $Name = $jsonResponse->stringOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name"); $Priority = $jsonResponse->IntOf("UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority"); $i = $i + 1; } $i = 0; $count_i = $jsonResponse->SizeOfArray("UserPool.AutoVerifiedAttributes"); while ($i < $count_i) { $jsonResponse->put_I($i); $strVal = $jsonResponse->stringOf("UserPool.AutoVerifiedAttributes[i]"); $i = $i + 1; } $i = 0; $count_i = $jsonResponse->SizeOfArray("UserPool.SchemaAttributes"); while ($i < $count_i) { $jsonResponse->put_I($i); $AttributeDataType = $jsonResponse->stringOf("UserPool.SchemaAttributes[i].AttributeDataType"); $DeveloperOnlyAttribute = $jsonResponse->BoolOf("UserPool.SchemaAttributes[i].DeveloperOnlyAttribute"); $Mutable = $jsonResponse->BoolOf("UserPool.SchemaAttributes[i].Mutable"); $Name = $jsonResponse->stringOf("UserPool.SchemaAttributes[i].Name"); $Required = $jsonResponse->BoolOf("UserPool.SchemaAttributes[i].Required"); $StringAttributeConstraintsMaxLength = $jsonResponse->stringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength"); $StringAttributeConstraintsMinLength = $jsonResponse->stringOf("UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength"); $NumberAttributeConstraintsMinValue = $jsonResponse->stringOf("UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue"); $i = $i + 1; } |
||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.