relyingPartyDetailedSummary 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 relying party configured with Active Directory Federation Services (AD FS), its aggregated usage, and whether the relying party configuration can be migrated to Microsoft Entra ID.

Methods

Method Return Type Description
List relyingPartyDetailedSummary relyingPartyDetailedSummary collection Get a summary of AD FS relying parties information.

Properties

Property Type Description
id String Read-only. Unique Identifier generated at API level.
relyingPartyId String This identifier is used to identify the relying party to this Federation Service. It's used when issuing claims to the relying party.
serviceId String Uniquely identifies the Active Directory forest.
migrationStatus migrationStatus Indication of whether the application can be moved to Microsoft Entra ID or require more investigation. Possible values are: ready, needsReview, additionalStepsRequired, unknownFutureValue.
migrationValidationDetails keyValuePair collection Specifies all the validations check done on applications configuration details to evaluate if the application is ready to be moved to Microsoft Entra ID.
relyingPartyName String Name of application or other entity on the internet that uses an identity provider to authenticate a user who wants to sign in.
failedSignInCount Int64 Number of failed sign in on Active Directory Federation Service in the period specified.
replyUrls String collection Specifies where the relying party expects to receive the token.
signInSuccessRate Double Number of successful / (number of successful + number of failed sign ins) on Active Directory Federation Service in the period specified.
successfulSignInCount Int64 Number of successful sign ins on Active Directory Federation Service.
totalSignInCount Int64 Number of successful + failed sign ins on Active Directory Federation Service in the period specified.
uniqueUserCount Int64 Number of unique users that have signed into the application.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "failedSignInCount": 10,
  "id": "String (identifier)",
  "migrationStatus": "ready | needsReview | additionalStepsRequired",
  "migrationValidationDetails": [{"@odata.type": "microsoft.graph.keyValuePair"}],
  "relyingPartyId": "String",
  "relyingPartyName": "String",
  "replyUrls": ["String"],
  "serviceId": "String (identifier)",
  "signInSuccessRate": 90.0,
  "successfulSignInCount": 90,
  "totalSignInCount": 100,
  "uniqueUserCount": 10
}