Android™
Android™
Amazon Cognito - Describe User Pool
See more Amazon Cognito Examples
Returns the configuration information and metadata of the specified user pool.Chilkat Android™ Downloads
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
boolean success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkRest rest = new CkRest();
CkAuthAws authAws = new CkAuthAws();
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/
boolean bTls = true;
int port = 443;
boolean 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) {
Log.i(TAG, "ConnectFailReason: " + String.valueOf(rest.get_ConnectFailReason()));
Log.i(TAG, 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.
CkJsonObject json = new CkJsonObject();
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 = new CkStringBuilder();
json.EmitSb(sbRequestBody);
CkStringBuilder sbResponseBody = new CkStringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success != true) {
Log.i(TAG, rest.lastErrorText());
return;
}
int respStatusCode = rest.get_ResponseStatusCode();
Log.i(TAG, "response status code = " + String.valueOf(respStatusCode));
if (respStatusCode != 200) {
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
Log.i(TAG, "Response Header:");
Log.i(TAG, rest.responseHeader());
Log.i(TAG, "Response Body:");
Log.i(TAG, sbResponseBody.getAsString());
return;
}
CkJsonObject jsonResponse = new CkJsonObject();
jsonResponse.LoadSb(sbResponseBody);
jsonResponse.put_EmitCompact(false);
Log.i(TAG, 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 {####}. "
// }
// }
// }
String Name;
int Priority;
String strVal;
String AttributeDataType;
boolean DeveloperOnlyAttribute;
boolean Mutable;
boolean Required;
String StringAttributeConstraintsMaxLength;
String StringAttributeConstraintsMinLength;
String NumberAttributeConstraintsMinValue;
boolean UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly = jsonResponse.BoolOf("UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly");
String UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage");
String UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject");
String UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage = jsonResponse.stringOf("UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage");
int UserPoolAdminCreateUserConfigUnusedAccountValidityDays = jsonResponse.IntOf("UserPool.AdminCreateUserConfig.UnusedAccountValidityDays");
String UserPoolArn = jsonResponse.stringOf("UserPool.Arn");
String UserPoolCreationDate = jsonResponse.stringOf("UserPool.CreationDate");
String UserPoolEmailConfigurationEmailSendingAccount = jsonResponse.stringOf("UserPool.EmailConfiguration.EmailSendingAccount");
String UserPoolEmailConfigurationFrom = jsonResponse.stringOf("UserPool.EmailConfiguration.From");
String UserPoolEmailConfigurationReplyToEmailAddress = jsonResponse.stringOf("UserPool.EmailConfiguration.ReplyToEmailAddress");
String UserPoolEmailConfigurationSourceArn = jsonResponse.stringOf("UserPool.EmailConfiguration.SourceArn");
String UserPoolEmailVerificationMessage = jsonResponse.stringOf("UserPool.EmailVerificationMessage");
String UserPoolEmailVerificationSubject = jsonResponse.stringOf("UserPool.EmailVerificationSubject");
int UserPoolEstimatedNumberOfUsers = jsonResponse.IntOf("UserPool.EstimatedNumberOfUsers");
String UserPoolId = jsonResponse.stringOf("UserPool.Id");
String UserPoolLastModifiedDate = jsonResponse.stringOf("UserPool.LastModifiedDate");
String UserPoolMfaConfiguration = jsonResponse.stringOf("UserPool.MfaConfiguration");
String UserPoolName = jsonResponse.stringOf("UserPool.Name");
int UserPoolPoliciesPasswordPolicyMinimumLength = jsonResponse.IntOf("UserPool.Policies.PasswordPolicy.MinimumLength");
boolean UserPoolPoliciesPasswordPolicyRequireLowercase = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireLowercase");
boolean UserPoolPoliciesPasswordPolicyRequireNumbers = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireNumbers");
boolean UserPoolPoliciesPasswordPolicyRequireSymbols = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireSymbols");
boolean UserPoolPoliciesPasswordPolicyRequireUppercase = jsonResponse.BoolOf("UserPool.Policies.PasswordPolicy.RequireUppercase");
int UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays = jsonResponse.IntOf("UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays");
String UserPoolSmsAuthenticationMessage = jsonResponse.stringOf("UserPool.SmsAuthenticationMessage");
String UserPoolSmsConfigurationExternalId = jsonResponse.stringOf("UserPool.SmsConfiguration.ExternalId");
String UserPoolSmsConfigurationSnsCallerArn = jsonResponse.stringOf("UserPool.SmsConfiguration.SnsCallerArn");
String UserPoolSmsVerificationMessage = jsonResponse.stringOf("UserPool.SmsVerificationMessage");
String UserPoolUserPoolTagsSampleUserPoolTag = jsonResponse.stringOf("UserPool.UserPoolTags.sampleUserPoolTag");
boolean UserPoolUsernameConfigurationCaseSensitive = jsonResponse.BoolOf("UserPool.UsernameConfiguration.CaseSensitive");
String UserPoolVerificationMessageTemplateDefaultEmailOption = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.DefaultEmailOption");
String UserPoolVerificationMessageTemplateEmailMessage = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.EmailMessage");
String UserPoolVerificationMessageTemplateEmailSubject = jsonResponse.stringOf("UserPool.VerificationMessageTemplate.EmailSubject");
String 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;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}