serviceActivity: getMetricsForSamlSignInSuccess

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 the number of SAML 2.0 authentications successfully processed by the Microsoft Entra cloud service for the tenant during a specified time period. This health signal currently doesn't include WS-FED/SAML 1.1 apps that are integrated with Microsoft Entra.

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.

In addition to the delegated permissions, the signed-in user who is accessing the data needs to belong to at least one of the following Microsoft Entra roles, which allow them to read sign-in reports:

  • Global Reader
  • Reports Reader
  • Security Administrator
  • Security Operator
  • Security Reader

HTTP request

GET /reports/serviceActivity/getMetricsForSamlSignInSuccess

Function parameters

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

Parameter Type Description
inclusiveIntervalStartDateTime DateTimeOffset Sets the starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.
exclusiveIntervalEndDateTime DateTimeOffset Sets the ending date and time in UTC. Required.
aggregationIntervalInMinutes Int32 Aggregation interval in minutes. The default value is 15, which sets the data to be aggregated into 15-minute sets. Allowed values are 5, 10, 15 and 30. Optional.

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 serviceActivityValueMetric collection in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForSamlSignInSuccess(inclusiveIntervalStartDateTime=2023-01-01T00:00:00Z,exclusiveIntervalEndDateTime=2023-01-01T00:20:00Z,aggregationIntervalInMinutes=10)

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

{
  "@odata.context": "https://graph.microsoft.com/beta/networkAccess/reports/$metadata#Collection(serviceActivityValueMetric)",
  "value": [
    {
      "intervalStartDateTime": "2023-01-10T00:00:00Z",
      "value": 4
    },
    {
      "intervalStartDateTime": "2023-01-10T00:10:00Z",
      "value": 5
    },
    {
      "intervalStartDateTime": "2023-01-10T00:20:00Z",
      "value": 4
    }
  ]
}