(JavaScript) Amazon Cognito - Admin Update User Attributes

See more Amazon Cognito Examples

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var rest = new CkRest();

var authAws = new CkAuthAws();
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 = true;
var port = 443;
var 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) {
    console.log("ConnectFailReason: " + rest.ConnectFailReason);
    console.log(rest.LastErrorText);
    return;
}

// 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"
// }
// 

var json = new CkJsonObject();
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");

var sbRequestBody = new CkStringBuilder();
json.EmitSb(sbRequestBody);
var sbResponseBody = new CkStringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var respStatusCode = rest.ResponseStatusCode;
console.log("response status code = " + respStatusCode);
if (respStatusCode !== 200) {
    console.log("Response Status Code = " + respStatusCode);
    console.log("Response Header:");
    console.log(rest.ResponseHeader);
    console.log("Response Body:");
    console.log(sbResponseBody.GetAsString());
    return;
}

var jsonResponse = new CkJsonObject();
jsonResponse.LoadSb(sbResponseBody);

jsonResponse.EmitCompact = false;
console.log(jsonResponse.Emit());

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