reportRoot: getRelyingPartyDetailedSummary

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 a summary of AD FS relying parties information.

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) Reports.Read.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Reports.Read.All Not available.

HTTP request

GET /reports/getRelyingPartyDetailedSummary(period='parameterValue')

Function parameters

In the request URL, provide the following query parameters with values.

Optional query parameters

This method supports the $filter and $orderby OData query parameters to help customize the response. For general information, see OData query parameters.

Parameter Type Description
period String Specifies the length of time over which the report is aggregated. The supported values are: D1, D7, D30. These values follow the format Dn where n represents the number of days over which the report is aggregated.

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 function returns a 200 OK response code and a relyingPartyDetailedSummary collection in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/getRelyingPartyDetailedSummary(period='D7')

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

{
  "value": [
        {
            "@odata.type": "#microsoft.graph.relyingPartyDetailedSummary",
            "id": "31b45f83-0f5c-40be-80af-02e918f3b55b",
            "relyingPartyId": "https://customer.contoso.com/mgmt",
            "serviceId": "4cce6fff-4ccc-41fe-8521-bce16ea521e9",
            "relyingPartyName": "Contoso",
            "successfulSignInCount": 0,
            "failedSignInCount": 225,
            "totalSignInCount": 225,
            "signInSuccessRate": 0,
            "uniqueUserCount": 1,
            "migrationStatus": "ready",
            "replyUrls": [
                "https://adfshelp.microsoft.com/Contoso/tokenresponse"
            ],
            "migrationValidationDetails": [
                {
                    "name": "AdditionalWSFedEndpointCheckResult",
                    "value": "{\"result\": 0, \"message\": \"No additional WS-Federation endpoints were found.\"}"
                },
                {
                    "name": "AllowedAuthenticationClassReferencesCheckResult",
                    "value": "{\"result\": 0, \"message\": \"AllowedAuthenticationClassReferences is not set up.\"}"
                }
            ]
        }
    ]
}