AWS solutions documentation change

Service: solutions · 2025-04-20 · Documentation low

File: solutions/latest/dea-api/users.md

Summary

Updated API documentation for user management endpoint with added schemas, properties, and audit-related terminology changes. Added response structure details, pagination parameters (limit/next), and renamed audit sections.

Security assessment

The changes add documentation about user management and audit capabilities (CSV export, audit by UserId), which are security-adjacent features for accountability and monitoring. However, there's no evidence of addressing a specific security vulnerability or weakness.

Diff

diff --git a/solutions/latest/dea-api/users.md b/solutions/latest/dea-api/users.md
index 6dbab20c9..8363a5998 100644
--- a//solutions/latest/dea-api/users.md
+++ b//solutions/latest/dea-api/users.md
@@ -5 +5 @@
-URIHTTP methods
+URIHTTP methodsSchemasProperties
@@ -8,0 +9,2 @@ URIHTTP methods
+This endpoint provides a way to manage users within the Digital Evidence Archive system, allowing administrators to retrieve information about users as needed. 
+
@@ -19,3 +21,2 @@ Query parametersName| Type| Required| Description
-`nameBeginsWith`| String| False|   
-  
-### OPTIONS
+`limit`| Integer| False|   
+`next`| String| False|   
@@ -25 +26,40 @@ ResponsesStatus code| Response model| Description
-`204`| None| 204 response  
+`200`| `Users_response_200`| Success Response  
+  
+## Schemas
+
+### Response bodies
+    
+    
+    {
+      "users": [
+        [
+          {
+            "ulid": "string",
+            "firstName": "string",
+            "lastName": "string",
+            "lowerFirstName": "string",
+            "lowerLastName": "string"
+          }
+        ]
+      ],
+      "next": "string"
+    }
+
+## Properties
+
+### User
+
+Property| Type| Required| Description  
+---|---|---|---  
+`firstName`| string| True|   
+`lastName`| string| True|   
+`lowerFirstName`| string| True|   
+`lowerLastName`| string| True|   
+`ulid`| string| True|   
+  
+### Users_response_200
+
+Property| Type| Required| Description  
+---|---|---|---  
+`next`| string| False|   
+`users`| Array of type Array of type User| False|   
@@ -33 +73 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please
-Ui Upload-files
+System audit – CSV export
@@ -35 +75 @@ Ui Upload-files
-Users userId Audit
+Users – Audit by UserId