|
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
(Swift 3,4,5...) 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
func chilkatTest() { // This example requires the Chilkat API to have been previously unlocked. // See Global Unlock Sample for sample code. let rest = CkoRest()! var success: Bool let authAws = CkoAuthAws()! 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/ var bTls: Bool = true var port: Int = 443 var bAutoReconnect: Bool = true // Use the same region as specified above. success = rest.connect("cognito-idp.us-west-2.amazonaws.com", port: port, tls: bTls, autoReconnect: bAutoReconnect) if success != true { print("ConnectFailReason: \(rest.connectFailReason.intValue)") print("\(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. let json = CkoJsonObject()! json.update("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") let sbRequestBody = CkoStringBuilder()! json.emitSb(sbRequestBody) let sbResponseBody = CkoStringBuilder()! success = rest.fullRequestSb("POST", uriPath: "/", requestBody: sbRequestBody, responseBody: sbResponseBody) if success != true { print("\(rest.lastErrorText!)") return } var respStatusCode: Int = rest.responseStatusCode.intValue print("response status code = \(respStatusCode)") if respStatusCode != 200 { print("Response Status Code = \(respStatusCode)") print("Response Header:") print("\(rest.responseHeader!)") print("Response Body:") print("\(sbResponseBody.getAsString()!)") return } let jsonResponse = CkoJsonObject()! jsonResponse.loadSb(sbResponseBody) jsonResponse.emitCompact = false print("\(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 {####}. " // } // } // } var Name: String? var Priority: Int var strVal: String? var AttributeDataType: String? var DeveloperOnlyAttribute: Bool var Mutable: Bool var Required: Bool var StringAttributeConstraintsMaxLength: String? var StringAttributeConstraintsMinLength: String? var NumberAttributeConstraintsMinValue: String? var UserPoolAdminCreateUserConfigAllowAdminCreateUserOnly: Bool = jsonResponse.bool(of: "UserPool.AdminCreateUserConfig.AllowAdminCreateUserOnly") var UserPoolAdminCreateUserConfigInviteMessageTemplateEmailMessage: String? = jsonResponse.string(of: "UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailMessage") var UserPoolAdminCreateUserConfigInviteMessageTemplateEmailSubject: String? = jsonResponse.string(of: "UserPool.AdminCreateUserConfig.InviteMessageTemplate.EmailSubject") var UserPoolAdminCreateUserConfigInviteMessageTemplateSMSMessage: String? = jsonResponse.string(of: "UserPool.AdminCreateUserConfig.InviteMessageTemplate.SMSMessage") var UserPoolAdminCreateUserConfigUnusedAccountValidityDays: Int = jsonResponse.int(of: "UserPool.AdminCreateUserConfig.UnusedAccountValidityDays").intValue var UserPoolArn: String? = jsonResponse.string(of: "UserPool.Arn") var UserPoolCreationDate: String? = jsonResponse.string(of: "UserPool.CreationDate") var UserPoolEmailConfigurationEmailSendingAccount: String? = jsonResponse.string(of: "UserPool.EmailConfiguration.EmailSendingAccount") var UserPoolEmailConfigurationFrom: String? = jsonResponse.string(of: "UserPool.EmailConfiguration.From") var UserPoolEmailConfigurationReplyToEmailAddress: String? = jsonResponse.string(of: "UserPool.EmailConfiguration.ReplyToEmailAddress") var UserPoolEmailConfigurationSourceArn: String? = jsonResponse.string(of: "UserPool.EmailConfiguration.SourceArn") var UserPoolEmailVerificationMessage: String? = jsonResponse.string(of: "UserPool.EmailVerificationMessage") var UserPoolEmailVerificationSubject: String? = jsonResponse.string(of: "UserPool.EmailVerificationSubject") var UserPoolEstimatedNumberOfUsers: Int = jsonResponse.int(of: "UserPool.EstimatedNumberOfUsers").intValue var UserPoolId: String? = jsonResponse.string(of: "UserPool.Id") var UserPoolLastModifiedDate: String? = jsonResponse.string(of: "UserPool.LastModifiedDate") var UserPoolMfaConfiguration: String? = jsonResponse.string(of: "UserPool.MfaConfiguration") var UserPoolName: String? = jsonResponse.string(of: "UserPool.Name") var UserPoolPoliciesPasswordPolicyMinimumLength: Int = jsonResponse.int(of: "UserPool.Policies.PasswordPolicy.MinimumLength").intValue var UserPoolPoliciesPasswordPolicyRequireLowercase: Bool = jsonResponse.bool(of: "UserPool.Policies.PasswordPolicy.RequireLowercase") var UserPoolPoliciesPasswordPolicyRequireNumbers: Bool = jsonResponse.bool(of: "UserPool.Policies.PasswordPolicy.RequireNumbers") var UserPoolPoliciesPasswordPolicyRequireSymbols: Bool = jsonResponse.bool(of: "UserPool.Policies.PasswordPolicy.RequireSymbols") var UserPoolPoliciesPasswordPolicyRequireUppercase: Bool = jsonResponse.bool(of: "UserPool.Policies.PasswordPolicy.RequireUppercase") var UserPoolPoliciesPasswordPolicyTemporaryPasswordValidityDays: Int = jsonResponse.int(of: "UserPool.Policies.PasswordPolicy.TemporaryPasswordValidityDays").intValue var UserPoolSmsAuthenticationMessage: String? = jsonResponse.string(of: "UserPool.SmsAuthenticationMessage") var UserPoolSmsConfigurationExternalId: String? = jsonResponse.string(of: "UserPool.SmsConfiguration.ExternalId") var UserPoolSmsConfigurationSnsCallerArn: String? = jsonResponse.string(of: "UserPool.SmsConfiguration.SnsCallerArn") var UserPoolSmsVerificationMessage: String? = jsonResponse.string(of: "UserPool.SmsVerificationMessage") var UserPoolUserPoolTagsSampleUserPoolTag: String? = jsonResponse.string(of: "UserPool.UserPoolTags.sampleUserPoolTag") var UserPoolUsernameConfigurationCaseSensitive: Bool = jsonResponse.bool(of: "UserPool.UsernameConfiguration.CaseSensitive") var UserPoolVerificationMessageTemplateDefaultEmailOption: String? = jsonResponse.string(of: "UserPool.VerificationMessageTemplate.DefaultEmailOption") var UserPoolVerificationMessageTemplateEmailMessage: String? = jsonResponse.string(of: "UserPool.VerificationMessageTemplate.EmailMessage") var UserPoolVerificationMessageTemplateEmailSubject: String? = jsonResponse.string(of: "UserPool.VerificationMessageTemplate.EmailSubject") var UserPoolVerificationMessageTemplateSmsMessage: String? = jsonResponse.string(of: "UserPool.VerificationMessageTemplate.SmsMessage") var i: Int = 0 var count_i: Int = jsonResponse.size(ofArray: "UserPool.AccountRecoverySetting.RecoveryMechanisms").intValue while i < count_i { jsonResponse.i = i Name = jsonResponse.string(of: "UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Name") Priority = jsonResponse.int(of: "UserPool.AccountRecoverySetting.RecoveryMechanisms[i].Priority").intValue i = i + 1 } i = 0 count_i = jsonResponse.size(ofArray: "UserPool.AutoVerifiedAttributes").intValue while i < count_i { jsonResponse.i = i strVal = jsonResponse.string(of: "UserPool.AutoVerifiedAttributes[i]") i = i + 1 } i = 0 count_i = jsonResponse.size(ofArray: "UserPool.SchemaAttributes").intValue while i < count_i { jsonResponse.i = i AttributeDataType = jsonResponse.string(of: "UserPool.SchemaAttributes[i].AttributeDataType") DeveloperOnlyAttribute = jsonResponse.bool(of: "UserPool.SchemaAttributes[i].DeveloperOnlyAttribute") Mutable = jsonResponse.bool(of: "UserPool.SchemaAttributes[i].Mutable") Name = jsonResponse.string(of: "UserPool.SchemaAttributes[i].Name") Required = jsonResponse.bool(of: "UserPool.SchemaAttributes[i].Required") StringAttributeConstraintsMaxLength = jsonResponse.string(of: "UserPool.SchemaAttributes[i].StringAttributeConstraints.MaxLength") StringAttributeConstraintsMinLength = jsonResponse.string(of: "UserPool.SchemaAttributes[i].StringAttributeConstraints.MinLength") NumberAttributeConstraintsMinValue = jsonResponse.string(of: "UserPool.SchemaAttributes[i].NumberAttributeConstraints.MinValue") i = i + 1 } } |
||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.