correlatedIdentity 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 a correlated identity result, containing the source and target identity details and the correlation status.

Inherits from entity.

Methods

Method	Return type	Description
List	correlatedIdentity collection	Get a list of the correlatedIdentity objects and their properties.
Get	correlatedIdentity	Read the properties of a correlatedIdentity object.

Properties

Property	Type	Description
correlatedDateTime	DateTimeOffset	The date and time when the identity was correlated. Supports $orderby.
error	correlationError	Error information if the correlation for this identity failed. null if successful. Supports $filter (eq).
id	String	The unique identifier for the correlated identity. Inherited from entity. Supports $filter (eq).
sourceIdentity	identityInfo	The source identity information from the on-premises directory. Supports $filter (eq).
status	String	The correlation and assignment status. Possible values include: uncorrelated, correlatedNotAssigned, correlatedAssigned and failToCorrelate. Supports $filter (eq), $count.
targetIdentity	identityInfo	The target identity information from Microsoft Entra ID. Supports $filter (eq).

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.correlatedIdentity",
  "id": "String (identifier)",
  "correlatedDateTime": "DateTimeOffset",
  "sourceIdentity": {
    "@odata.type": "microsoft.graph.identityInfo"
  },
  "targetIdentity": {
    "@odata.type": "microsoft.graph.identityInfo"
  },
  "status": "String",
  "error": {
    "@odata.type": "microsoft.graph.correlationError"
  }
}