AWS singlesignon documentation change

Service: singlesignon · 2025-05-31 · Documentation low

File: singlesignon/latest/IdentityStoreAPIReference/API_UpdateUser.md

Summary

Added examples for updating user attributes, including nickname, username, family name, and phone number. Removed a redundant introductory sentence.

Security assessment

The changes provide usage examples for the UpdateUser API but do not address security vulnerabilities or introduce security-related documentation. The examples focus on standard user attribute updates.

Diff

diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_UpdateUser.md b/singlesignon/latest/IdentityStoreAPIReference/API_UpdateUser.md
index 89e1bf0f6..5d7d85899 100644
--- a//singlesignon/latest/IdentityStoreAPIReference/API_UpdateUser.md
+++ b//singlesignon/latest/IdentityStoreAPIReference/API_UpdateUser.md
@@ -5 +5 @@
-Request SyntaxRequest ParametersResponse ElementsErrorsSee Also
+Request SyntaxRequest ParametersResponse ElementsErrorsExamplesSee Also
@@ -9,2 +8,0 @@ Request SyntaxRequest ParametersResponse ElementsErrorsSee Also
-Updates the specified user metadata and attributes in the specified identity store.
-
@@ -131,0 +130,87 @@ HTTP Status Code: 400
+## Examples
+
+### Example 1
+
+This example updates the specified user's nickname to Johnny and the user name to John Doe.
+
+#### Sample Request
+    
+    
+    {
+        "IdentityStoreId": "d-1234567890",
+        "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+        "Operations": [
+            {
+                "AttributePath": "nickName",
+                "AttributeValue": "Johnny"
+            },
+            {
+                "AttributePath": "userName",
+                "AttributeValue": "John Doe"
+            }
+        ]
+    }
+    
+
+#### Sample Response
+    
+    
+    No response
+    
+
+### Example 2
+
+This example updates the family name of the specified user to Smith. 
+
+#### Sample Request
+    
+    
+    {
+        "IdentityStoreId": "d-1234567890",
+        "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+        "Operations": [
+            {
+                "AttributePath": "name.familyName",
+                "AttributeValue": "Smith"
+            }
+        ]
+    }
+    
+
+#### Sample Response
+    
+    
+    No response
+    
+
+### Example 3
+
+This example updates the phone number for the specified user. 
+
+#### Sample Request
+    
+    
+    {
+        "IdentityStoreId": "d-1234567890",
+        "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+        "Operations": [
+            {
+                "AttributePath": "phoneNumbers",
+                "AttributeValue": [
+                {
+                    "Value": "832-555-0100",
+                    "Type": "home",
+                    "Primary": true
+                }
+              ]
+            }
+        ]
+    }
+    
+
+#### Sample Response
+    
+    
+    No response
+    
+