identityCorrelation resource type

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.

Represents an identity correlation report that captures the results of correlating identities between an on-premises directory and Microsoft Entra ID for a specific service principal.

Inherits from entity.

Methods

Method	Return type	Description
List	identityCorrelation collection	Get a list of the identityCorrelation objects and their properties.
Get	identityCorrelation	Read the properties and relationships of an identityCorrelation object.
List identities	correlatedIdentity collection	List the correlated identities for this identity correlation report.

Properties

Property	Type	Description
endDateTime	DateTimeOffset	The date and time when the correlation process completed.
error	correlationError	Error information if the correlation process failed. null if successful. Supports $filter (eq).
id	String	The unique identifier for the identity correlation report. Inherited from entity. Supports $filter (eq).
startDateTime	DateTimeOffset	The date and time when the correlation process started.

Relationships

Relationship	Type	Description
identities	correlatedIdentity collection	The collection of correlated identity results for this correlation report.
servicePrincipal	servicePrincipal	The service principal associated with this correlation report.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityCorrelation",
  "id": "String (identifier)",
  "startDateTime": "DateTimeOffset",
  "endDateTime": "DateTimeOffset",
  "error": {
    "@odata.type": "microsoft.graph.correlationError"
  },
  "servicePrincipal": {
    "@odata.type": "microsoft.graph.servicePrincipal"
  }
}