(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

Dim authAws As Chilkat.AuthAws
Set authAws = Chilkat.NewAuthAws
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
Dim success As Boolean
success = 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) Then
    Debug.Print "ConnectFailReason: "; rest.ConnectFailReason
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.UpdateString("UserAttributes[0].Name","email_verified")
success = json.UpdateString("UserAttributes[0].Value","true")
success = json.UpdateString("UserAttributes[1].Name","email")
success = json.UpdateString("UserAttributes[1].Value","matt@example.com")
success = json.UpdateString("UserPoolId","us-west-2_yt6WzO3SA")
success = json.UpdateString("Username","Matt")

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

Dim sbRequestBody As Chilkat.StringBuilder
Set sbRequestBody = Chilkat.NewStringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If


respStatusCode = rest.ResponseStatusCode
Debug.Print "response status code = "; respStatusCode
If (respStatusCode <> 200) Then
    Debug.Print "Response Status Code = "; respStatusCode
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print "Response Body:"
    Debug.Print sbResponseBody.GetAsString()
    Exit Sub
End If

Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
success = jsonResponse.LoadSb(sbResponseBody)

jsonResponse.EmitCompact = False
Debug.Print jsonResponse.Emit()

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