(Delphi DLL) Amazon Cognito - Describe User Pool

See more Amazon Cognito Examples

Returns 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

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, AuthAws, Rest, JsonObject, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
rest: HCkRest;
success: Boolean;
authAws: HCkAuthAws;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;
respStatusCode: Integer;
jsonResponse: HCkJsonObject;
Name: PWideChar;
Priority: Integer;
strVal: PWideChar;
AttributeDataType: PWideChar;
DeveloperOnlyAttribute: Boolean;
Mutable: Boolean;
Required: Boolean;
StringAttributeConstraintsMaxLength: PWideChar;
StringAttributeConstraintsMinLength: PWideChar;
NumberAttributeConstraintsMinValue: PWideChar;
UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly: Boolean;
UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage: PWideChar;
UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject: PWideChar;
UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage: PWideChar;
UserPoolAdminCreateUserConfigUnusedAccountValidityDays: Integer;
UserPoolArn: PWideChar;
UserPoolCreationDate: PWideChar;
UserPoolEmailConfigurationEmailSendingAccount: PWideChar;
UserPoolEmailConfigurationFrom: PWideChar;
UserPoolEmailConfigurationReplyToEmailAddress: PWideChar;
UserPoolEmailConfigurationSourceArn: PWideChar;
UserPoolEmailVerificationMessage: PWideChar;
UserPoolEmailVerificationSubject: PWideChar;
UserPoolEstimatedNumberOfUsers: Integer;
UserPoolId: PWideChar;
UserPoolLastModifiedDate: PWideChar;
UserPoolMfaConfiguration: PWideChar;
UserPoolName: PWideChar;
UserPoolPoliciesPasswordPolicyMinimumLength: Integer;
UserPoolPoliciesPasswordPolicyRequireLowercase: Boolean;
UserPoolPoliciesPasswordPolicyRequireNumbers: Boolean;
UserPoolPoliciesPasswordPolicyRequireSymbols: Boolean;
UserPoolPoliciesPasswordPolicyRequireUppercase: Boolean;
UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays: Integer;
UserPoolSmsAuthenticationMessage: PWideChar;
UserPoolSmsConfigurationExternalId: PWideChar;
UserPoolSmsConfigurationSnsCallerArn: PWideChar;
UserPoolSmsVerificationMessage: PWideChar;
UserPoolUserPoolTagsSampleUserPoolTag: PWideChar;
UserPoolUsernameConfigurationCaseSensitive: Boolean;
UserPoolVerificationMessageTemplateDefaultEmailOption: PWideChar;
UserPoolVerificationMessageTemplateEmailMessage: PWideChar;
UserPoolVerificationMessageTemplateEmailSubject: PWideChar;
UserPoolVerificationMessageTemplateSmsMessage: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(CkRest_getConnectFailReason(rest)));
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  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.

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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

respStatusCode := CkRest_getResponseStatusCode(rest);
Memo1.Lines.Add('response status code = ' + IntToStr(respStatusCode));
if (respStatusCode <> 200) then
  begin
    Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponseBody));
    Exit;
  end;

jsonResponse := CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

CkJsonObject_putEmitCompact(jsonResponse,False);
Memo1.Lines.Add(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 {####}. "
//     }
//   }
// }

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 do
  begin
    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;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'UserPool.AutoVerifiedAttributes');
while i < count_i do
  begin
    CkJsonObject_putI(jsonResponse,i);
    strVal := CkJsonObject__stringOf(jsonResponse,'UserPool.AutoVerifiedAttributes[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'UserPool.SchemaAttributes');
while i < count_i do
  begin
    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;
  end;

CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);

end;