Skip to content

Commit 922830b

Browse files
Merge branch 'iot/device-prov-apis' of https://github.com/microsoftgraph/microsoft-graph-docs into iot/device-prov-apis
2 parents c0f153a + fd54297 commit 922830b

23 files changed

+245
-213
lines changed

api-reference/beta/api/devicetemplate-get.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ GET /directory/templates/deviceTemplates/{id}
4343
4444
## Optional query parameters
4545

46-
This method supports the `$select` [OData query parameters](/graph/query-parameters) to help customize the response. The following table lists examples.
46+
This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
4747

4848
## Request headers
4949

@@ -63,10 +63,10 @@ For more information, see [Microsoft Graph error responses and resource types](/
6363

6464
## Examples
6565

66+
### Request
67+
6668
The following example shows how to get a device template by its **id** with a certificate authority-issued mTLS certificate.
6769

68-
### Request
69-
The following example shows a request.
7070
<!-- {
7171
"blockType": "request",
7272
"name": "get_devicetemplate"

api-reference/beta/api/devicetemplate-list-owners.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ GET /directory/templates/deviceTemplates/{id}/owners
4040
4141
## Optional query parameters
4242

43-
This method supports the `$select` and `$top` OData query parameters to help customize the response. Page size for `$top` results is between 1 and 999 inclusive. For general information, see [OData query parameters](/graph/query-parameters).
43+
This method supports the `$select` and `$top` OData query parameters to help customize the response. The page size for `$top` results is between 1 and 999, inclusive. For general information, see [OData query parameters](/graph/query-parameters).
4444

4545
## Request headers
4646

@@ -54,7 +54,7 @@ Don't supply a request body for this method.
5454

5555
## Response
5656

57-
If successful, this method returns a `200 OK` response code and a collection of [directoryObject](../resources/directoryObject.md) objects in the response body, with the `@odata.type` property of each object in the collection indicating the directory object type. Only [service principals](../resources/serviceprincipal.md), [users](../resources/users.md), or [applications](../resources/application.md) can be owners of device templates.
57+
If successful, this method returns a `200 OK` response code and a collection of [directoryObject](../resources/directoryObject.md) objects in the response body, with the **@odata.type** property of each object in the collection indicating the directory object type. Only [service principals](../resources/serviceprincipal.md), [users](../resources/users.md), or [applications](../resources/application.md) can be owners of device templates.
5858

5959
For more information, see [Microsoft Graph error responses and resource types](/graph/errors).
6060

@@ -81,7 +81,7 @@ The following example shows the response.
8181
<!-- {
8282
"blockType": "response",
8383
"truncated": true,
84-
"@odata.type": "Collection(microsoft.graph.servicePrincipal)"
84+
"@odata.type": "Collection(microsoft.graph.directoryObject)"
8585
}
8686
-->
8787
``` http

api-reference/beta/api/devicetemplate-post-owners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

17-
Add a new owner to a [deviceTemplate](../resources/devicetemplate.md) object. Owners are granted permissions to enable or disable devices and update properties like **alternativeNames** for the devices created from these device templates. As an owner, no other administrator roles are necessary to create, update, delete the devices from this template, as well as to add or remove template owners. Owners added via this API can are returned in a [list device owners](../api/devicetemplate-list-owners.md) request.
17+
Add a new owner to a [deviceTemplate](../resources/devicetemplate.md) object. Owners are granted permissions to enable or disable devices and update properties, such as **alternativeNames**, for the devices created from these device templates. As an owner, no other administrator roles are necessary to create, update, or delete devices from this template, as well as to add or remove template owners. Owners added via this API are returned in a [list device owners](../api/devicetemplate-list-owners.md) request.
1818

1919
## Permissions
2020

api-reference/beta/api/template-list-devicetemplates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ GET /directory/templates/deviceTemplates
3838

3939
## Optional query parameters
4040

41-
This method supports the `$filter`, `$select`, and `$top` OData query parameters to help customize the response. Page size for `$top` results is between 1 and 999 inclusive. For general information, see [OData query parameters](/graph/query-parameters).
41+
This method supports the `$filter`, `$select`, and `$top` OData query parameters to help customize the response. The page size for `$top` results is between 1 and 999, inclusive. For general information, see [OData query parameters](/graph/query-parameters).
4242

4343
## Request headers
4444

api-reference/beta/api/template-post-devicetemplates.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,14 @@ For more information, see [Microsoft Graph error responses and resource types](/
7070

7171
## Examples
7272

73-
### Example 1:
73+
### Example 1: Create a new device template
74+
75+
The following example shows how to create a new [deviceTemplate](../resources/devicetemplate.md).
76+
7477
#### Request
78+
7579
The following example shows a request.
80+
7681
<!-- {
7782
"blockType": "request",
7883
"name": "create_devicetemplate_from_"
@@ -120,9 +125,14 @@ Content-Type: application/json
120125
}
121126
```
122127

123-
### Example 2: Create a device from template with owner.
128+
### Example 2: Create a device template with an owner
129+
130+
The following example shows how to create a new [deviceTemplate](../resources/devicetemplate.md) with an owner.
131+
124132
#### Request
133+
125134
The following example shows a request.
135+
126136
<!-- {
127137
"blockType": "request",
128138
"name": "create_devicetemplate_from_with_owner"

api-reference/beta/includes/rbac-for-apis/rbac-devicetemplate-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ms.topic: include
44
---
55

66
> [!IMPORTANT]
7-
> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
7+
> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation:
88
> - Cloud Device Administrator
99
> - IoT Device Administrator
1010
> - Users

api-reference/beta/includes/rbac-for-apis/rbac-mtlsoauthconfig-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ ms.topic: include
44
---
55

66
> [!IMPORTANT]
7-
> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
7+
> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation:
88
> - Cloud Device Administrator
99
> - IoT Device Administrator
Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "Working with the authentication methods usage report API"
3-
description: "The authentication methods usage report helps you understand how users in your organization are using Microsoft Entra authentication capabilities such as self-service password reset and multifactor authentication (MFA)."
3+
description: "Authentication methods activity reports provides information on the registration and usage of authentication methods in your tenant."
44
ms.localizationpriority: medium
5-
author: "egreenberg14"
6-
ms.subservice: "entra-monitoring-health"
5+
ms.subservice: entra-monitoring-health
6+
author: faithombongi
7+
ms.author: ombongifaith
8+
ms.reviewer: egreenberg
79
doc_type: "conceptualPageType"
810
ms.date: 01/18/2024
911
---
@@ -14,34 +16,32 @@ Namespace: microsoft.graph
1416

1517
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1618

17-
The authentication methods usage reports help you understand how users in your organization are using [Microsoft Entra authentication capabilities](../resources/authenticationmethods-overview.md) such as multifactor authentication (MFA), Self-Service Password Reset (SSPR), and Passwordless authentication.
19+
Authentication methods activity reports provides information on the registration and usage of [authentication methods](../resources/authenticationmethods-overview.md) in your tenant.
1820

1921
These reports provide information such as:
2022

2123
- How many users are registered for each authentication method
22-
- How many users are registered for features such as multifactor authentication (MFA), Self-Service Password Reset (SSPR), and Passwordless authentication.
23-
- The failure rates of each authentication method
24+
- How many users are registered for features such as multifactor authentication (MFA), Self-Service Password Reset (SSPR), and passwordless authentication.
25+
- The failure rates of each authentication method
26+
27+
These reports are available on the Microsoft Entra portal through **Protection** tab group > **Authentication methods** tab > **Activity** tab under the *Monitoring* tab group.
2428

2529
## Licenses
2630

27-
A Microsoft Entra ID P1 or P2 license is required to access usage and insights. Microsoft Entra multifactor authentication and self-service password reset (SSPR) licensing information can be found on the [Microsoft Entra pricing site](https://azure.microsoft.com/pricing/details/active-directory/).
31+
A Microsoft Entra ID P1 or P2 license is required to access authentication methods usage and insights reports. Microsoft Entra multifactor authentication and self-service password reset (SSPR) licensing information can be found on the [Microsoft Entra pricing site](https://www.microsoft.com/security/business/microsoft-entra-pricing).
2832

29-
## Common requests
33+
## Available reports
3034

31-
The following table lists some common requests that you can use with this API.
35+
The following reports are available through Microsoft Graph:
36+
- Users registered and capable of self-service password reset (SSPR) and Azure multifactor authentication (MFA). For more information, see the [credentialUserRegistrationCount resource type](../resources/credentialuserregistrationcount.md).
37+
- SSPR usage activity. For more information, see the [userCredentialUsageDetails resource type](../resources/usercredentialusagedetails.md).
38+
- Tenant-level summary of user SSPR activity, including failure and successes. For more information, see the [credentialUsageSummary resource type](../resources/credentialusagesummary.md).
39+
- Per-user report of the status of their authentication methods including the default methods, whether registered for MFA, SSPR, and a passwordless authentication method, and so on. For more information, see the [userRegistrationDetails resource type](../resources/userRegistrationDetails.md).
40+
- Count of users registered, enabled, and capable of using MFA, SSPR, and passwordless authentication. For more information, see the [usersRegisteredByFeature resource type](../resources/userregistrationfeaturesummary.md).
41+
- Raw count of users registered for email, password, and phone authentication methods. For more information, see the [usersRegisteredByMethod resource type](../resources/userregistrationmethodsummary.md).
42+
- (**Deprecated.** Use the [userRegistrationDetails resource type](../resources/userRegistrationDetails.md) instead) Per-user registration and usage details for different authentication methods, SSPR, and MFA. For more information, see the [credentialUserRegistrationDetails resource type](../resources/credentialuserregistrationdetails.md).
3243

33-
| Operation | Try in Graph Explorer | Description |
34-
| --------- | --- | ----------- |
35-
| [getCredentialUserRegistrationcount](../resources/credentialuserregistrationcount.md) | [GET /credentialuserregistrationcount](https://developer.microsoft.com/graph/graph-explorer?request=reports/getCredentialUserRegistrationcount()&version=beta) | Get the number of users registered for self-service password reset and MFA. |
36-
| [getCredentialUsageSummary](../resources/credentialusagesummary.md) | [GET /credentialusagesummary](https://developer.microsoft.com/graph/graph-explorer?request=reports/getCredentialUsageSummary&version=beta) | Get the number of users using self-service password reset. |
37-
| [credentialUserRegistrationDetails (deprecated)](../resources/credentialuserregistrationdetails.md) | [GET /credentialuserregistrationdetails](https://developer.microsoft.com/graph/graph-explorer?request=reports/credentialUserRegistrationDetails&version=beta) | Get the user details for self-service password reset and MFA registration activities. |
38-
| [userCredentialUsageDetails](../resources/usercredentialusagedetails.md) | [GET /usercredentialusagedetails](https://developer.microsoft.com/graph/graph-explorer?request=reports/userCredentialUsageDetails&version=beta) | Get user details for all self-service password reset activities. |
39-
| [usersRegisteredByFeature](../resources/userregistrationfeaturesummary.md) | [GET /authenticationMethods/usersRegisteredByFeature](https://developer.microsoft.com/graph/graph-explorer?request=reports/authenticationMethods/usersRegisteredByFeature(includedUserTypes='all',includedUserRoles='all')&version=beta) | Get the number of users capable of multifactor authentication, self-service password reset and passwordless authentication. |
40-
| [usersRegisteredByMethod](../resources/userregistrationmethodsummary.md) | [GET /authenticationMethods/usersRegisteredByMethod](https://developer.microsoft.com/graph/graph-explorer?request=reports/authenticationMethods/usersRegisteredByMethod(includedUserTypes='all',includedUserRoles='all')&version=beta) | Get the number of users registered for each authentication method. |
41-
| [userRegistrationDetails](../resources/userRegistrationDetails.md) | [GET /authenticationMethods/userRegistrationDetails](https://developer.microsoft.com/graph/graph-explorer?request=reports/authenticationMethods/userRegistrationDetails&version=beta) | Get the MFA registration details for all users. |
4244

4345
## Related content
4446

45-
- Learn how to [deploy Microsoft Entra self-service password reset](/azure/active-directory/authentication/howto-sspr-deployment).
46-
- Learn how to deploy [Microsoft Entra multifactor authentication](/azure/active-directory/authentication/howto-mfa-getstarted).
47-
- Learn how to enable [combined security info registration](/azure/active-directory/authentication/howto-registration-mfa-sspr-combined).
47+
- [Microsoft Entra authentication methods activity](/entra/identity/authentication/howto-authentication-methods-activity)

0 commit comments

Comments
 (0)