|
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 <C_CkRest.h> #include <C_CkAuthAws.h> #include <C_CkJsonObject.h> #include <C_CkStringBuilder.h> void ChilkatSample(void) { HCkRest rest; BOOL success; HCkAuthAws authAws; BOOL bTls; int port; BOOL bAutoReconnect; HCkJsonObject json; HCkStringBuilder sbRequestBody; HCkStringBuilder sbResponseBody; int respStatusCode; HCkJsonObject jsonResponse; const char *Name; int Priority; const char *strVal; const char *AttributeDataType; BOOL DeveloperOnlyAttribute; BOOL Mutable; BOOL Required; const char *StringAttributeConstraintsMaxLength; const char *StringAttributeConstraintsMinLength; const char *NumberAttributeConstraintsMinValue; BOOL UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly; const char *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage; const char *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject; const char *UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage; int UserPoolAdminCreateUserConfigUnusedAccountValidityDays; const char *UserPoolArn; const char *UserPoolCreationDate; const char *UserPoolEmailConfigurationEmailSendingAccount; const char *UserPoolEmailConfigurationFrom; const char *UserPoolEmailConfigurationReplyToEmailAddress; const char *UserPoolEmailConfigurationSourceArn; const char *UserPoolEmailVerificationMessage; const char *UserPoolEmailVerificationSubject; int UserPoolEstimatedNumberOfUsers; const char *UserPoolId; const char *UserPoolLastModifiedDate; const char *UserPoolMfaConfiguration; const char *UserPoolName; int UserPoolPoliciesPasswordPolicyMinimumLength; BOOL UserPoolPoliciesPasswordPolicyRequireLowercase; BOOL UserPoolPoliciesPasswordPolicyRequireNumbers; BOOL UserPoolPoliciesPasswordPolicyRequireSymbols; BOOL UserPoolPoliciesPasswordPolicyRequireUppercase; int UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays; const char *UserPoolSmsAuthenticationMessage; const char *UserPoolSmsConfigurationExternalId; const char *UserPoolSmsConfigurationSnsCallerArn; const char *UserPoolSmsVerificationMessage; const char *UserPoolUserPoolTagsSampleUserPoolTag; BOOL UserPoolUsernameConfigurationCaseSensitive; const char *UserPoolVerificationMessageTemplateDefaultEmailOption; const char *UserPoolVerificationMessageTemplateEmailMessage; const char *UserPoolVerificationMessageTemplateEmailSubject; const char *UserPoolVerificationMessageTemplateSmsMessage; int i; int count_i; // This example requires the Chilkat API to have been previously unlocked. // See Global Unlock Sample for sample code. rest = CkRest_Create(); authAws = CkAuthAws_Create(); CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY"); CkAuthAws_putSecretKey(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_putRegion(authAws,"us-west-2"); CkAuthAws_putServiceName(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/ bTls = TRUE; port = 443; bAutoReconnect = TRUE; // Use the same region as specified above. success = CkRest_Connect(rest,"cognito-idp.us-west-2.amazonaws.com",port,bTls,bAutoReconnect); if (success != TRUE) { printf("ConnectFailReason: %d\n",CkRest_getConnectFailReason(rest)); printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkAuthAws_Dispose(authAws); 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. json = CkJsonObject_Create(); 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"); sbRequestBody = CkStringBuilder_Create(); CkJsonObject_EmitSb(json,sbRequestBody); sbResponseBody = CkStringBuilder_Create(); success = CkRest_FullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody); if (success != TRUE) { printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkAuthAws_Dispose(authAws); CkJsonObject_Dispose(json); CkStringBuilder_Dispose(sbRequestBody); CkStringBuilder_Dispose(sbResponseBody); return; } respStatusCode = CkRest_getResponseStatusCode(rest); printf("response status code = %d\n",respStatusCode); if (respStatusCode != 200) { printf("Response Status Code = %d\n",respStatusCode); printf("Response Header:\n"); printf("%s\n",CkRest_responseHeader(rest)); printf("Response Body:\n"); printf("%s\n",CkStringBuilder_getAsString(sbResponseBody)); CkRest_Dispose(rest); CkAuthAws_Dispose(authAws); CkJsonObject_Dispose(json); CkStringBuilder_Dispose(sbRequestBody); CkStringBuilder_Dispose(sbResponseBody); return; } jsonResponse = CkJsonObject_Create(); CkJsonObject_LoadSb(jsonResponse,sbResponseBody); CkJsonObject_putEmitCompact(jsonResponse,FALSE); printf("%s\n",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 {####}. " // } // } // } // 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. UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = CkJsonObject_BoolOf(jsonResponse,"UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly"); UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage"); UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = CkJsonObject_stringOf(jsonResponse,"UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject"); UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage"); UserPoolAdminCreateUserConfigUnusedAccountValidityDays = CkJsonObject_IntOf(jsonResponse,"UserPool.AdminCreateUserConfig.UnusedAccountValidityDays"); UserPoolArn = CkJsonObject_stringOf(jsonResponse,"UserPool.Arn"); UserPoolCreationDate = CkJsonObject_stringOf(jsonResponse,"UserPool.CreationDate"); UserPoolEmailConfigurationEmailSendingAccount = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailConfiguration.EmailSendingAccount"); UserPoolEmailConfigurationFrom = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailConfiguration.From"); UserPoolEmailConfigurationReplyToEmailAddress = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailConfiguration.ReplyToEmailAddress"); UserPoolEmailConfigurationSourceArn = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailConfiguration.SourceArn"); UserPoolEmailVerificationMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailVerificationMessage"); UserPoolEmailVerificationSubject = CkJsonObject_stringOf(jsonResponse,"UserPool.EmailVerificationSubject"); UserPoolEstimatedNumberOfUsers = CkJsonObject_IntOf(jsonResponse,"UserPool.EstimatedNumberOfUsers"); UserPoolId = CkJsonObject_stringOf(jsonResponse,"UserPool.Id"); UserPoolLastModifiedDate = CkJsonObject_stringOf(jsonResponse,"UserPool.LastModifiedDate"); UserPoolMfaConfiguration = CkJsonObject_stringOf(jsonResponse,"UserPool.MfaConfiguration"); UserPoolName = CkJsonObject_stringOf(jsonResponse,"UserPool.Name"); UserPoolPoliciesPasswordPolicyMinimumLength = CkJsonObject_IntOf(jsonResponse,"UserPool.Policies.PasswordPolicy.MinimumLength"); UserPoolPoliciesPasswordPolicyRequireLowercase = CkJsonObject_BoolOf(jsonResponse,"UserPool.Policies.PasswordPolicy.RequireLowercase"); UserPoolPoliciesPasswordPolicyRequireNumbers = CkJsonObject_BoolOf(jsonResponse,"UserPool.Policies.PasswordPolicy.RequireNumbers"); UserPoolPoliciesPasswordPolicyRequireSymbols = CkJsonObject_BoolOf(jsonResponse,"UserPool.Policies.PasswordPolicy.RequireSymbols"); UserPoolPoliciesPasswordPolicyRequireUppercase = CkJsonObject_BoolOf(jsonResponse,"UserPool.Policies.PasswordPolicy.RequireUppercase"); UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = CkJsonObject_IntOf(jsonResponse,"UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays"); UserPoolSmsAuthenticationMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.SmsAuthenticationMessage"); UserPoolSmsConfigurationExternalId = CkJsonObject_stringOf(jsonResponse,"UserPool.SmsConfiguration.ExternalId"); UserPoolSmsConfigurationSnsCallerArn = CkJsonObject_stringOf(jsonResponse,"UserPool.SmsConfiguration.SnsCallerArn"); UserPoolSmsVerificationMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.SmsVerificationMessage"); UserPoolUserPoolTagsSampleUserPoolTag = CkJsonObject_stringOf(jsonResponse,"UserPool.UserPoolTags.sampleUserPoolTag"); UserPoolUsernameConfigurationCaseSensitive = CkJsonObject_BoolOf(jsonResponse,"UserPool.UsernameConfiguration.CaseSensitive"); UserPoolVerificationMessageTemplateDefaultEmailOption = CkJsonObject_stringOf(jsonResponse,"UserPool.VerificationMessageTemplate.DefaultEmailOption"); UserPoolVerificationMessageTemplateEmailMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.VerificationMessageTemplate.EmailMessage"); UserPoolVerificationMessageTemplateEmailSubject = CkJsonObject_stringOf(jsonResponse,"UserPool.VerificationMessageTemplate.EmailSubject"); UserPoolVerificationMessageTemplateSmsMessage = CkJsonObject_stringOf(jsonResponse,"UserPool.VerificationMessageTemplate.SmsMessage"); i = 0; count_i = CkJsonObject_SizeOfArray(jsonResponse,"UserPool.AccountRecoverySetting.RecoveryMechanisms"); while (i < count_i) { CkJsonObject_putI(jsonResponse,i); Name = CkJsonObject_stringOf(jsonResponse,"UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name"); Priority = CkJsonObject_IntOf(jsonResponse,"UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority"); i = i + 1; } i = 0; count_i = CkJsonObject_SizeOfArray(jsonResponse,"UserPool.AutoVerifiedAttributes"); while (i < count_i) { CkJsonObject_putI(jsonResponse,i); strVal = CkJsonObject_stringOf(jsonResponse,"UserPool.AutoVerifiedAttributes[i]"); i = i + 1; } i = 0; count_i = CkJsonObject_SizeOfArray(jsonResponse,"UserPool.SchemaAttributes"); while (i < count_i) { CkJsonObject_putI(jsonResponse,i); AttributeDataType = CkJsonObject_stringOf(jsonResponse,"UserPool.SchemaAttributes[i].AttributeDataType"); DeveloperOnlyAttribute = CkJsonObject_BoolOf(jsonResponse,"UserPool.SchemaAttributes[i].DeveloperOnlyAttribute"); Mutable = CkJsonObject_BoolOf(jsonResponse,"UserPool.SchemaAttributes[i].Mutable"); Name = CkJsonObject_stringOf(jsonResponse,"UserPool.SchemaAttributes[i].Name"); Required = CkJsonObject_BoolOf(jsonResponse,"UserPool.SchemaAttributes[i].Required"); StringAttributeConstraintsMaxLength = CkJsonObject_stringOf(jsonResponse,"UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength"); StringAttributeConstraintsMinLength = CkJsonObject_stringOf(jsonResponse,"UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength"); NumberAttributeConstraintsMinValue = CkJsonObject_stringOf(jsonResponse,"UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue"); i = i + 1; } CkRest_Dispose(rest); CkAuthAws_Dispose(authAws); CkJsonObject_Dispose(json); CkStringBuilder_Dispose(sbRequestBody); CkStringBuilder_Dispose(sbResponseBody); CkJsonObject_Dispose(jsonResponse); } |
|||||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.