authenticationMethodsRoot: usersRegisteredByMethod

Namespace: microsoft.graph

Get the number of users registered for each authentication method.

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

In delegated scenarios with work or school accounts, the signed-in user must be an owner or member of the group or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

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

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. Possible values are: all, privilegedAdmin, admin, user.
includedUserTypes	includedUserTypes	User type. 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/v1.0/reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='all',includedUserRoles='all')

CLI

mgc reports authentication-methods users-registered-by-method-with-included-user-types-with-included-user-roles get --included-user-types {included-user-types-id} --included-user-roles {included-user-roles-id} 

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let userRegistrationMethodSummary = await client.api('/reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='all',includedUserRoles='all')')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the 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
    }
  ]
}