List customSecurityAttributeAudits

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get the list of audit logs generated by activities related to custom security attribute management in Microsoft Entra ID.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) CustomSecAttributeAuditLogs.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application CustomSecAttributeAuditLogs.Read.All Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following privileged roles are supported for this operation.

  • Attribute Log Reader
  • Attribute Log Administrator

By default, Global Administrator and other administrator roles do not have permissions to read custom security attribute audit logs.

HTTP request

GET /auditLogs/customSecurityAttributeAudits

Optional query parameters

This method supports the $filter (eq, ge, le, startswith), $top, $orderby, and skiptoken OData query parameters to help customize the response. The default page size and maximum for $top is 100 objects. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of customSecurityAttributeAudit objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/auditLogs/customSecurityAttributeAudits?$top=1

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": "testid",
        "category": "AttributeManagement",
        "correlationId": "79896ecf-ed75-4cee-8769-a51b639264ca",
        "result": "success",
        "resultReason": "",
        "activityDisplayName": "Add custom security attribute definition in an attribute set",
        "activityDateTime": "2024-01-07T19:02:30.433478Z",
        "loggedByService": "Core Directory",
        "operationType": "Add",
        "userAgent": null,
        "initiatedBy": {
            "app": null,
            "user": {
                "id": "dcb1b5f4-0829-4252-9f45-810ac1c2f91b",
                "displayName": null,
                "userPrincipalName": "admin1@contoso.com",
                "ipAddress": "{ipAddress}",
                "homeTenantId": null,
                "homeTenantName": null
            }
        },
        "targetResources": [
            {
                "id": "934760c7-fba0-4ba6-8438-3d1e40eb8d01",
                "displayName": null,
                "type": "Other",
                "userPrincipalName": null,
                "groupType": null,
                "modifiedProperties": [
                    {
                        "displayName": "Included Updated Properties",
                        "oldValue": null,
                        "newValue": "\"\""
                    },
                    {
                        "displayName": "TargetId.UserType",
                        "oldValue": null,
                        "newValue": "\"Member\""
                    }
                ]
            }
        ],
        "additionalDetails": [
            {
                "key": "User-Agent",
                "value": "{value}"
            }
        ]
    }
]