authenticationMethodsRoot: usersRegisteredByFeature

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 users capable of multi-factor authentication, self-service password reset, and passwordless authentication.

Permissions

The following permissions are required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	AuditLog.Read.All
Delegated (personal Microsoft account)	Not supported.
Application	Not supported.

In order to access the API, one of the following roles is required:

• Reports reader
• Security reader
• Security admin
• Global reader
• Global admin

HTTP request

GET /reports/authenticationMethods/usersRegisteredByFeature

Function parameters

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

Parameter	Type	Description
includedUserTypes	includedUserTypes	User type. Possible values are: all, member, guest.
includedUserRoles	includedUserRoles	User role type. Possible values are: all, privilegedAdmin, admin, user.

The value privilegedAdmin consists of the following privileged admin roles:

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

The value admin includes all Azure AD admin roles.

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a userRegistrationFeatureSummary in the response body.

Examples

Request

HTTP

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

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var userRegistrationFeatureSummary = await graphClient.Reports.AuthenticationMethods
	.UsersRegisteredByFeature(IncludedUserTypes.All,IncludedUserRoles.All)
	.Request()
	.GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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 userRegistrationFeatureSummary = await client.api('/reports/authenticationMethods/usersRegisteredByFeature(includedUserTypes='all',includedUserRoles='all')')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

UserRegistrationFeatureSummary userRegistrationFeatureSummary = graphClient.reports().authenticationMethods()
	.usersRegisteredByFeature(AuthenticationMethodsRootUsersRegisteredByFeatureParameterSet
		.newBuilder()
		.withIncludedUserTypes('all')
		.withIncludedUserRoles('all')
		.build())
	.buildRequest()
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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

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.userRegistrationFeatureSummary",
	"totalUserCount": 23123,
	"userTypes": "all",
	"userRoles": "all",
	"userRegistrationFeatureCounts": [{
			"feature": "ssprRegistered",
			"userCount": 23423
		},
		{
			"feature": "ssprEnabled",
			"userCount": 4234
		},
		{
			"feature": "ssprCapable",
			"userCount": 4234
		}, {
			"feature": "passwordlessCapable",
			"userCount": 323
		},
		{
			"feature": "mfaCapable",
			"userCount": 3345
		}
	]
}