(Ruby) Amazon Cognito - Admin Update User Attributes

See more Amazon Cognito Examples

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

For more information, see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
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/
bTls = true
port = 443
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)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#     "UserAttributes": [
#          {
#            "Name": "email_verified",
#            "Value": "true"
#          },
#          {
#            "Name": "email",
#            "Value": "matt@example.com"
#          }
#        ],
#      "UserPoolId": "us-west-2_yt6WzO3SA",
#      "Username": "Matt"
# }
# 

json = Chilkat::CkJsonObject.new()
json.UpdateString("UserAttributes[0].Name","email_verified")
json.UpdateString("UserAttributes[0].Value","true")
json.UpdateString("UserAttributes[1].Name","email")
json.UpdateString("UserAttributes[1].Value","matt@example.com")
json.UpdateString("UserPoolId","us-west-2_yt6WzO3SA")
json.UpdateString("Username","Matt")

rest.AddHeader("Content-Type","application/x-amz-json-1.0")
rest.AddHeader("X-Amz-Target","AWSCognitoIdentityProviderService.AdminUpdateUserAttributes")
rest.AddHeader("Accept-Encoding","identity")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Status Code = " + respStatusCode.to_s() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.LoadSb(sbResponseBody)

jsonResponse.put_EmitCompact(false)
print jsonResponse.emit() + "\n";

# If successful, the response status code is 200, and the response body is empty JSON "{}"