directoryAudit resource type

  • 2 minutes to read
  • Contributors
    • Lance Leonard (MSFT)
    • Laura Graham
    • finsharp
    • Jeremy Thake (Microsoft)
    • Office GSX

This resource represents the directory Audit items and its collection

Methods

Method Return Type Description
List directoryAudits directoryAudit List the directory audit items in the collection and their properties.
Get directoryAudit directoryAudit Get a specific directory audit item and its properties.

Properties

Property Type Description
activityDateTime DateTimeOffset Indicates the date and time the activity was performed. The Timestamp type is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
activityDisplayName String Indicates the activity name or the operation name (E.g. "Create User", "Add member to group"). For a list of activities logged,refer to Azure Ad activity list.
additionalDetails keyValue collection Indicates additional details on the activity.
category String Indicates which resource category that's targeted by the activity. (For example: User Management, Group Management etc..)
correlationId GUID Indicates a unique ID that helps correlate activities that span across various services. Can be used to trace logs across services.
id String Indicates the unique ID for the activity. This is a GUID.
initiatedBy auditActivityInitiator Indicates information about the user or app initiated the activity.
loggedByService String Indicates information on which service initiated the activity (For example: Self-service Password Management, Core Directory, B2C, Invited Users, Microsoft Identity Manager, Privileged Identity Management.
result string Indicates the result of the activity.Possible values are: success, failure, timeout, unknownFutureValue.
resultReason String Indicates the reason for failure if the result is "Failure" or "timeout".
targetResources targetResource collection Indicates information on which resource was changed due to the activity. Target Resource Type can be User, Device, Directory, App, Role, Group, Policy or Other.

Relationships

None

JSON representation

Here is a JSON representation of the resource.

{
  "activityDateTime": "String (timestamp)",
  "activityDisplayName": "String",
  "additionalDetails": [{"@odata.type": "microsoft.graph.keyValue"}],
  "category": "String",
  "correlationId": "Guid",
  "id": "String (identifier)",
  "initiatedBy": {"@odata.type": "microsoft.graph.auditActivityInitiator"},
  "loggedByService": "String",
  "result": "string",
  "resultReason": "String",
  "targetResources": [{"@odata.type": "microsoft.graph.targetResource"}]
}