|
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
(C++) 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
#include <CkRest.h> #include <CkAuthAws.h> #include <CkJsonObject.h> #include <CkStringBuilder.h> void ChilkatSample(void) { // This example requires the Chilkat API to have been previously unlocked. // See Global Unlock Sample for sample code. CkRest rest; bool success; CkAuthAws authAws; 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/ bool bTls = true; int port = 443; bool bAutoReconnect = true; // Use the same region as specified above. success = rest.Connect("cognito-idp.us-west-2.amazonaws.com",port,bTls,bAutoReconnect); if (success != true) { std::cout << "ConnectFailReason: " << rest.get_ConnectFailReason() << "\r\n"; std::cout << rest.lastErrorText() << "\r\n"; return; } // 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. CkJsonObject json; 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"); CkStringBuilder sbRequestBody; json.EmitSb(sbRequestBody); CkStringBuilder sbResponseBody; success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody); if (success != true) { std::cout << rest.lastErrorText() << "\r\n"; return; } int respStatusCode = rest.get_ResponseStatusCode(); std::cout << "response status code = " << respStatusCode << "\r\n"; if (respStatusCode != 200) { std::cout << "Response Status Code = " << respStatusCode << "\r\n"; std::cout << "Response Header:" << "\r\n"; std::cout << rest.responseHeader() << "\r\n"; std::cout << "Response Body:" << "\r\n"; std::cout << sbResponseBody.getAsString() << "\r\n"; return; } CkJsonObject jsonResponse; jsonResponse.LoadSb(sbResponseBody); jsonResponse.put_EmitCompact(false); std::cout << 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 {####}. " // } // } // } // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat. // See this example explaining how this memory should be used: const char * functions. const char *Name = 0; int Priority; const char *strVal = 0; const char *AttributeDataType = 0; bool DeveloperOnlyAttribute; bool Mutable; bool Required; const char *StringAttributeConstraintsMaxLength = 0; const char *StringAttributeConstraintsMinLength = 0; const char *NumberAttributeConstraintsMinValue = 0; bool UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = jsonResponse.BoolOf("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly"); const char *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage"); const char *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject"); const char *UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage"); int UserPoolAdminCreateUserConfigUnusedAccountValidityDays = jsonResponse.IntOf("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays"); const char *UserPoolArn = jsonResponse.stringOf("UserPool.Arn"); const char *UserPoolCreationDate = jsonResponse.stringOf("UserPool.CreationDate"); const char *UserPoolEmailConfigurationEmailSendingAccount = jsonResponse.stringOf("UserPool.EmailConfiguration.EmailSendingAccount"); const char *UserPoolEmailConfigurationFrom = jsonResponse.stringOf("UserPool.EmailConfiguration.From"); const char *UserPoolEmailConfigurationReplyToEmailAddress = jsonResponse.stringOf("UserPool.EmailConfiguration.ReplyToEmailAddress"); const char *UserPoolEmailConfigurationSourceArn = jsonResponse.stringOf("UserPool.EmailConfiguration.SourceArn"); const char *UserPoolEmailVerificationMessage = jsonResponse.stringOf("UserPool.EmailVerificationMessage"); const char *UserPoolEmailVerificationSubject = jsonResponse.stringOf("UserPool.EmailVerificationSubject"); int UserPoolEstimatedNumberOfUsers = jsonResponse.IntOf("UserPool.EstimatedNumberOfUsers"); const char *UserPoolId = jsonResponse.stringOf("UserPool.Id"); const char *UserPoolLastModifiedDate = jsonResponse.stringOf("UserPool.LastModifiedDate"); const char *UserPoolMfaConfiguration = jsonResponse.stringOf("UserPool.MfaConfiguration"); const char *UserPoolName = jsonResponse.stringOf("UserPool.Name"); int UserPoolPoliciesPasswordPolicyMinimumLength = jsonResponse.IntOf("UserPool.Policies.PasswordPolicy.MinimumLength"); bool UserPoolPoliciesPasswordPolicyRequireLowercase = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireLowercase"); bool UserPoolPoliciesPasswordPolicyRequireNumbers = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireNumbers"); bool UserPoolPoliciesPasswordPolicyRequireSymbols = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireSymbols"); bool UserPoolPoliciesPasswordPolicyRequireUppercase = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireUppercase"); int UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = jsonResponse.IntOf("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays"); const char *UserPoolSmsAuthenticationMessage = jsonResponse.stringOf("UserPool.SmsAuthenticationMessage"); const char *UserPoolSmsConfigurationExternalId = jsonResponse.stringOf("UserPool.SmsConfiguration.ExternalId"); const char *UserPoolSmsConfigurationSnsCallerArn = jsonResponse.stringOf("UserPool.SmsConfiguration.SnsCallerArn"); const char *UserPoolSmsVerificationMessage = jsonResponse.stringOf("UserPool.SmsVerificationMessage"); const char *UserPoolUserPoolTagsSampleUserPoolTag = jsonResponse.stringOf("UserPool.UserPoolTags.sampleUserPoolTag"); bool UserPoolUsernameConfigurationCaseSensitive = jsonResponse.BoolOf("UserPool.UsernameConfiguration.CaseSensitive"); const char *UserPoolVerificationMessageTemplateDefaultEmailOption = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.DefaultEmailOption"); const char *UserPoolVerificationMessageTemplateEmailMessage = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.EmailMessage"); const char *UserPoolVerificationMessageTemplateEmailSubject = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.EmailSubject"); const char *UserPoolVerificationMessageTemplateSmsMessage = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.SmsMessage"); int i = 0; int 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.