Objective-C
Objective-C
Amazon Cognito - Describe User Pool
See more Amazon Cognito Examples
Returns the configuration information and metadata of the specified user pool.Chilkat Objective-C Downloads
#import <CkoRest.h>
#import <CkoAuthAws.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
BOOL success = NO;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoRest *rest = [[CkoRest alloc] init];
CkoAuthAws *authAws = [[CkoAuthAws alloc] init];
authAws.AccessKey = @"AWS_ACCESS_KEY";
authAws.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.Region = @"us-west-2";
authAws.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 = YES;
int port = 443;
BOOL bAutoReconnect = YES;
// Use the same region as specified above.
success = [rest Connect: @"cognito-idp.us-west-2.amazonaws.com" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success != YES) {
NSLog(@"%@%d",@"ConnectFailReason: ",[rest.ConnectFailReason intValue]);
NSLog(@"%@",rest.LastErrorText);
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.
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"UserPoolId" value: @"us-west-2_yt6WzO3SA"];
[rest AddHeader: @"Content-Type" value: @"application/x-amz-json-1.0"];
[rest AddHeader: @"X-Amz-Target" value: @"AWSCognitoIdentityProviderService.DescribeUserPool"];
[rest AddHeader: @"Accept-Encoding" value: @"identity"];
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
NSLog(@"%@",rest.LastErrorText);
return;
}
int respStatusCode = [rest.ResponseStatusCode intValue];
NSLog(@"%@%d",@"response status code = ",respStatusCode);
if (respStatusCode != 200) {
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",rest.ResponseHeader);
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[sbResponseBody GetAsString]);
return;
}
CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
[jsonResponse LoadSb: sbResponseBody];
jsonResponse.EmitCompact = NO;
NSLog(@"%@",[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 {####}. "
// }
// }
// }
NSString *Name = 0;
int Priority;
NSString *strVal = 0;
NSString *AttributeDataType = 0;
BOOL DeveloperOnlyAttribute;
BOOL Mutable;
BOOL Required;
NSString *StringAttributeConstraintsMaxLength = 0;
NSString *StringAttributeConstraintsMinLength = 0;
NSString *NumberAttributeConstraintsMinValue = 0;
BOOL UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = [jsonResponse BoolOf: @"UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly"];
NSString *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = [jsonResponse StringOf: @"UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage"];
NSString *UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = [jsonResponse StringOf: @"UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject"];
NSString *UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = [jsonResponse StringOf: @"UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage"];
int UserPoolAdminCreateUserConfigUnusedAccountValidityDays = [[jsonResponse IntOf: @"UserPool.AdminCreateUserConfig.UnusedAccountValidityDays"] intValue];
NSString *UserPoolArn = [jsonResponse StringOf: @"UserPool.Arn"];
NSString *UserPoolCreationDate = [jsonResponse StringOf: @"UserPool.CreationDate"];
NSString *UserPoolEmailConfigurationEmailSendingAccount = [jsonResponse StringOf: @"UserPool.EmailConfiguration.EmailSendingAccount"];
NSString *UserPoolEmailConfigurationFrom = [jsonResponse StringOf: @"UserPool.EmailConfiguration.From"];
NSString *UserPoolEmailConfigurationReplyToEmailAddress = [jsonResponse StringOf: @"UserPool.EmailConfiguration.ReplyToEmailAddress"];
NSString *UserPoolEmailConfigurationSourceArn = [jsonResponse StringOf: @"UserPool.EmailConfiguration.SourceArn"];
NSString *UserPoolEmailVerificationMessage = [jsonResponse StringOf: @"UserPool.EmailVerificationMessage"];
NSString *UserPoolEmailVerificationSubject = [jsonResponse StringOf: @"UserPool.EmailVerificationSubject"];
int UserPoolEstimatedNumberOfUsers = [[jsonResponse IntOf: @"UserPool.EstimatedNumberOfUsers"] intValue];
NSString *UserPoolId = [jsonResponse StringOf: @"UserPool.Id"];
NSString *UserPoolLastModifiedDate = [jsonResponse StringOf: @"UserPool.LastModifiedDate"];
NSString *UserPoolMfaConfiguration = [jsonResponse StringOf: @"UserPool.MfaConfiguration"];
NSString *UserPoolName = [jsonResponse StringOf: @"UserPool.Name"];
int UserPoolPoliciesPasswordPolicyMinimumLength = [[jsonResponse IntOf: @"UserPool.Policies.PasswordPolicy.MinimumLength"] intValue];
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"] intValue];
NSString *UserPoolSmsAuthenticationMessage = [jsonResponse StringOf: @"UserPool.SmsAuthenticationMessage"];
NSString *UserPoolSmsConfigurationExternalId = [jsonResponse StringOf: @"UserPool.SmsConfiguration.ExternalId"];
NSString *UserPoolSmsConfigurationSnsCallerArn = [jsonResponse StringOf: @"UserPool.SmsConfiguration.SnsCallerArn"];
NSString *UserPoolSmsVerificationMessage = [jsonResponse StringOf: @"UserPool.SmsVerificationMessage"];
NSString *UserPoolUserPoolTagsSampleUserPoolTag = [jsonResponse StringOf: @"UserPool.UserPoolTags.sampleUserPoolTag"];
BOOL UserPoolUsernameConfigurationCaseSensitive = [jsonResponse BoolOf: @"UserPool.UsernameConfiguration.CaseSensitive"];
NSString *UserPoolVerificationMessageTemplateDefaultEmailOption = [jsonResponse StringOf: @"UserPool.VerificationMessageTemplate.DefaultEmailOption"];
NSString *UserPoolVerificationMessageTemplateEmailMessage = [jsonResponse StringOf: @"UserPool.VerificationMessageTemplate.EmailMessage"];
NSString *UserPoolVerificationMessageTemplateEmailSubject = [jsonResponse StringOf: @"UserPool.VerificationMessageTemplate.EmailSubject"];
NSString *UserPoolVerificationMessageTemplateSmsMessage = [jsonResponse StringOf: @"UserPool.VerificationMessageTemplate.SmsMessage"];
int i = 0;
int count_i = [[jsonResponse SizeOfArray: @"UserPool.AccountRecoverySetting.RecoveryMechanisms"] intValue];
while (i < count_i) {
jsonResponse.I = [NSNumber numberWithInt: i];
Name = [jsonResponse StringOf: @"UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name"];
Priority = [[jsonResponse IntOf: @"UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority"] intValue];
i = i + 1;
}
i = 0;
count_i = [[jsonResponse SizeOfArray: @"UserPool.AutoVerifiedAttributes"] intValue];
while (i < count_i) {
jsonResponse.I = [NSNumber numberWithInt: i];
strVal = [jsonResponse StringOf: @"UserPool.AutoVerifiedAttributes[i]"];
i = i + 1;
}
i = 0;
count_i = [[jsonResponse SizeOfArray: @"UserPool.SchemaAttributes"] intValue];
while (i < count_i) {
jsonResponse.I = [NSNumber numberWithInt: 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;
}