Skip to content

authenticationmethodsroot-usersregisteredbymethod.md

Latest commit

 

History

History
134 lines (101 loc) · 4.06 KB

authenticationmethodsroot-usersregisteredbymethod.md

File metadata and controls

134 lines (101 loc) · 4.06 KB
title authenticationMethodsRoot: usersRegisteredByMethod
description Get the number of users registered for each authentication method.
author egreenberg14
ms.localizationpriority medium
ms.subservice entra-monitoring-health
doc_type apiPageType
ms.date 04/05/2024
ms.custom sfi-ga-nochange

authenticationMethodsRoot: usersRegisteredByMethod

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get the number of users registered for each authentication method.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-reports-registration-usage-apis]

HTTP request

GET /reports/authenticationMethods/usersRegisteredByMethod

Function parameters

The following table shows the parameters that can be used with this function.

Parameter Type Description
includedUserRoles includedUserRoles The role type for the user. The possible values are: all, privilegedAdmin, admin, user.
includedUserTypes includedUserTypes User type. The possible values are: all, member, guest.

The value privilegedAdmin consists of the following Microsoft Entra roles:

  • Global Administrator
  • Security Administrator
  • Conditional Access Administrator
  • Exchange Administrator
  • SharePoint Administrator
  • Helpdesk Administrator
  • Billing Administrator
  • User Administrator
  • Authentication Administrator

The value admin includes all Microsoft Entra admin roles.

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

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='all',includedUserRoles='all')

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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.type": "#microsoft.graph.userRegistrationMethodSummary",
  "userTypes": "all",
  "userRoles": "all",
  "userRegistrationMethodCounts": [
    {
      "authenticationMethod": "password",
      "userCount": 12209
    },
    {
      "authenticationMethod": "windowsHelloForBusiness",
      "userCount": 223
    },
    {
      "authenticationMethod": "mobilePhone",
      "userCount": 4234
    }
  ]
}