Merge pull request #25981 from microsoftgraph/directoryAudits-complexFilter

Add example of complex type filtering - directoryAudits LIST

Author: FaithOmbongi

api-reference/beta/api/directoryaudit-list.md

@@ -52,9 +52,11 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `200 OK` response code and a collection of [directoryAudit](../resources/directoryaudit.md) objects in the response body.
 
-## Example
+## Examples
 
-### Request
+### Example 1: Retrieve the list of audit logs
+
+#### Request
 
 The following example shows a request.
 
@@ -102,7 +104,7 @@ GET https://graph.microsoft.com/beta/auditLogs/directoryAudits
 
 ---
 
-### Response
+#### Response
 
 The following example shows the response.
 
@@ -175,6 +177,79 @@ Content-type: application/json
 }
 ```
 
+### Example 2: Retrieve the list of audit logs with a filter on initiatedBy/user
+
+#### Request
+
+The following example shows a request.
+
+<!-- {
+  "blockType": "request",
+  "name": "get_directoryaudits_filter_initiatedby"
+}-->
+
+```http
+GET https://graph.microsoft.com/beta/auditLogs/directoryAudits?$filter=initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'
+```
+
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+  "blockType": "response",
+  "truncated": true,
+  "@odata.type": "microsoft.graph.directoryAudit",
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+    "@odata.context": "https://graph.microsoft.com/beta/$metadata#auditLogs/directoryAudits",
+    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET auditLogs/directoryAudits?$select=activityDateTime,activityDisplayName",
+    "value": [
+        {
+            "id": "SSGM_b662f17a-4e4d-4e1c-9248-cdec180024b2_MCDC4_88453290",
+            "category": "GroupManagement",
+            "correlationId": "b662f17a-4e4d-4e1c-9248-cdec180024b2",
+            "result": "success",
+            "resultReason": "OK",
+            "activityDisplayName": "GroupLifecyclePolicies_Get",
+            "activityDateTime": "2024-12-27T10:01:19.5796748Z",
+            "loggedByService": "Self-service Group Management",
+            "operationType": "Update",
+            "userAgent": null,
+            "initiatedBy": {
+                "app": null,
+                "user": {
+                    "id": "00000000-0000-0000-0000-000000000000",
+                    "displayName": null,
+                    "userPrincipalName": null,
+                    "ipAddress": "10.0.0.0",
+                    "userType": null,
+                    "homeTenantId": null,
+                    "homeTenantName": null
+                }
+            },
+            "targetResources": [
+                {
+                    "id": "00000000-0000-0000-0000-000000000000",
+                    "displayName": null,
+                    "type": "N/A",
+                    "userPrincipalName": null,
+                    "groupType": null,
+                    "modifiedProperties": []
+                }
+            ],
+            "additionalDetails": []
+        }
+    ]
+}
+```
+
 <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
 2015-10-25 14:57:30 UTC -->
 <!-- {

api-reference/v1.0/api/directoryaudit-list.md

@@ -51,9 +51,11 @@ Don't supply a request body for this method.
 
 If successful, this method returns a `200 OK` response code and a collection of [directoryAudit](../resources/directoryaudit.md) objects in the response body.
 
-## Example
+## Examples
 
-### Request
+### Example 1: Retrieve the list of audit logs
+
+#### Request
 
 The following example shows a request.
 
@@ -102,7 +104,7 @@ GET https://graph.microsoft.com/v1.0/auditLogs/directoryAudits
 
 ---
 
-### Response
+#### Response
 
 The following example shows the response.
 
@@ -166,6 +168,78 @@ Content-type: application/json
 }
 ```
 
+### Example 2: Retrieve the list of audit logs with a filter on initiatedBy/user
+
+#### Request
+
+The following example shows a request.
+
+<!-- {
+  "blockType": "request",
+  "name": "get_directoryaudits_filter_initiatedby"
+}-->
+
+```http
+GET https://graph.microsoft.com/v1.0/auditLogs/directoryAudits?$filter=initiatedBy/user/id eq '00000000-0000-0000-0000-000000000000'
+```
+
+#### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+  "blockType": "response",
+  "truncated": true,
+  "@odata.type": "microsoft.graph.directoryAudit",
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#auditLogs/directoryAudits",
+    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET auditLogs/directoryAudits?$select=activityDateTime,activityDisplayName",
+    "value": [
+        {
+            "id": "SSGM_b662f17a-4e4d-4e1c-9248-cdec180024b2_MCDC4_88453290",
+            "category": "GroupManagement",
+            "correlationId": "b662f17a-4e4d-4e1c-9248-cdec180024b2",
+            "result": "success",
+            "resultReason": "OK",
+            "activityDisplayName": "GroupLifecyclePolicies_Get",
+            "activityDateTime": "2024-12-27T10:01:19.5796748Z",
+            "loggedByService": "Self-service Group Management",
+            "operationType": "Update",
+            "initiatedBy": {
+                "app": null,
+                "user": {
+                    "id": "00000000-0000-0000-0000-000000000000",
+                    "displayName": null,
+                    "userPrincipalName": null,
+                    "ipAddress": "10.0.0.0",
+                    "userType": null,
+                    "homeTenantId": null,
+                    "homeTenantName": null
+                }
+            },
+            "targetResources": [
+                {
+                    "id": "00000000-0000-0000-0000-000000000000",
+                    "displayName": null,
+                    "type": "N/A",
+                    "userPrincipalName": null,
+                    "groupType": null,
+                    "modifiedProperties": []
+                }
+            ],
+            "additionalDetails": []
+        }
+    ]
+}
+```
+
 <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
 2015-10-25 14:57:30 UTC -->
 <!-- {