title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
List recommendations |
Get a list of the recommendation objects and their properties. |
ddeeps2610 |
medium |
entra-monitoring-health |
apiPageType |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Get a list of the recommendation objects and their properties.
[!INCLUDE national-cloud-support]
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-directory-recommendations-apis-read]
GET /directory/recommendations
This method supports $select
and $filter
OData query parameters to help customize the response. $expand
is supported by the impactedResources relationship. For general information, see OData query parameters.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and a collection of recommendation objects in the response body.
The following example shows a request.
GET https://graph.microsoft.com/beta/directory/recommendations
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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/$metadata#directory/recommendations",
"value": [
{
"id": "0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.TurnOffPerUserMFA",
"recommendationType": "turnOffPerUserMFA",
"createdDateTime": "2022-02-28T02:53:00Z",
"impactStartDateTime": "2022-02-28T02:53:00Z",
"postponeUntilDateTime": null,
"lastModifiedDateTime": "2023-01-10T22:57:10.2509132Z",
"lastModifiedBy": "b5fa65db-0d2b-4233-8788-ab0213567669",
"currentScore": 0.0,
"maxScore": 5.0,
"displayName": "Convert from per-user MFA to Conditional Access MFA",
"featureAreas": [
"conditionalAccess"
],
"insights": "13 users are currently configured for per-user Multi-Factor Authentication (MFA). However, there are 6 users configured for Conditional Access (CA) MFA. The per-user MFA configuration supersedes the MFA settings applied via CA policies, potentially creating unnecessary MFA prompts.",
"benefits": "Improve user productivity and minimize sign-in time with fewer MFA prompts. Ensure that your most sensitive resources can have the tighest controls, while your least sensitive resources can be more freely accessible.",
"category": "identityBestPractice",
"status": "active",
"priority": "medium",
"releaseType": "preview",
"impactType": "users",
"remediationImpact": "",
"actionSteps": [
{
"stepNumber": 1,
"text": "1. To get started, confirm that there is an existing CA policy with an MFA requirement. Ensure that you are covering all resources and users you would like to secure with MFA.",
"actionUrl": {
"displayName": "Click here to view your CA policies",
"url": "https://portal.azure.com/#blade/Microsoft_AAD_IAM/PoliciesTemplateBlade"
}
},
{
"stepNumber": 2,
"text": "2. To require MFA via a CA policy, follow the steps in this tutorial.",
"actionUrl": {
"displayName": "Secure user sign-in events with Azure AD Multi-Factor Authentication",
"url": "https://docs.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa?toc=/azure/active-directory/conditional-access/toc.json&bc=/azure/active-directory/conditional-access/breadcrumb/toc.json"
}
},
{
"stepNumber": 3,
"text": "3. Ensure that the per-user MFA configuration is turned off",
"actionUrl": {
"displayName": "Navigate to MFA settings.",
"url": "https://account.activedirectory.windowsazure.com/UserManagement/MfaSettings.aspx"
}
}
]
},
]
}
The following example shows a request.
GET https://graph.microsoft.com/beta/directory/recommendations?$filter=recommendationType eq 'turnOffPerUserMFA'
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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/$metadata#directory/recommendations/$entity",
"id": "0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.TurnOffPerUserMFA",
"recommendationType": "turnOffPerUserMFA",
"createdDateTime": "2022-02-28T02:53:00Z",
"impactStartDateTime": "2022-02-28T02:53:00Z",
"postponeUntilDateTime": null,
"lastModifiedDateTime": "2023-01-10T22:57:10.2509132Z",
"lastModifiedBy": "d5a3853c-8e04-42b6-a530-bf159e99174a",
"currentScore": 0.0,
"maxScore": 5.0,
"displayName": "Convert from per-user MFA to Conditional Access MFA",
"featureAreas": [
"conditionalAccess"
],
"insights": "13 users are currently configured for per-user Multi-Factor Authentication (MFA)...",
"benefits": "Improve user productivity and minimize sign-in time with fewer MFA prompts...",
"category": "identityBestPractice",
"status": "active",
"priority": "medium",
"releaseType": "preview",
"impactType": "users",
"remediationImpact": "",
"actionSteps": [
{
"stepNumber": 1,
"text": "1. To get started, confirm that...",
"actionUrl": {
"displayName": "Click here to view your CA policies",
"url": "https://portal.azure.com/#blade/Microsoft_AAD_IAM/PoliciesTemplateBlade"
}
},
{
"stepNumber": 2,
"text": "2. To require MFA via a CA policy, follow the steps in this tutorial.",
"actionUrl": {
"displayName": "Secure user sign-in events with Azure AD Multi-Factor Authentication",
"url": "https://docs.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa?toc=/azure/active-directory/conditional-access/toc.json&bc=/azure/active-directory/conditional-access/breadcrumb/toc.json"
}
},
{
"stepNumber": 3,
"text": "3. Ensure that the per-user MFA configuration is turned off",
"actionUrl": {
"displayName": "Navigate to MFA settings.",
"url": "https://account.activedirectory.windowsazure.com/UserManagement/MfaSettings.aspx"
}
}
]
}
The following example shows a request.
GET https://graph.microsoft.com/beta/directory/recommendations?$filter=id eq '0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.TurnOffPerUserMFA'&$expand=impactedResources
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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/$metadata#directory/recommendations(impactedResources())",
"id": "0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.TurnOffPerUserMFA",
"recommendationType": "turnOffPerUserMFA",
"createdDateTime": "2022-02-28T02:53:00Z",
"impactStartDateTime": "2022-02-28T02:53:00Z",
"postponeUntilDateTime": null,
"lastModifiedDateTime": "2023-01-10T22:57:10.2509132Z",
"lastModifiedBy": "d5a3853c-8e04-42b6-a530-bf159e99174a",
"currentScore": 0.0,
"maxScore": 5.0,
"displayName": "Convert from per-user MFA to Conditional Access MFA",
"featureAreas": [
"conditionalAccess"
],
"insights": "13 users are currently configured for per-user Multi-Factor Authentication (MFA). However, there are 6 users configured for Conditional Access (CA) MFA. The per-user MFA configuration supersedes the MFA settings applied via CA policies, potentially creating unnecessary MFA prompts.",
"benefits": "Improve user productivity and minimize sign-in time with fewer MFA prompts. Ensure that your most sensitive resources can have the tighest controls, while your least sensitive resources can be more freely accessible.",
"category": "identityBestPractice",
"status": "active",
"priority": "medium",
"releaseType": "preview",
"impactType": "users",
"remediationImpact": "",
"actionSteps": [
{
"stepNumber": 1,
"text": "1. To get started, confirm that there is an existing CA policy with an MFA requirement. Ensure that you are covering all resources and users you would like to secure with MFA.",
"actionUrl": {
"displayName": "Click here to view your CA policies",
"url": "https://portal.azure.com/#blade/Microsoft_AAD_IAM/PoliciesTemplateBlade"
}
},
{
"stepNumber": 2,
"text": "2. To require MFA via a CA policy, follow the steps in this tutorial.",
"actionUrl": {
"displayName": "Secure user sign-in events with Azure AD Multi-Factor Authentication",
"url": "https://docs.microsoft.com/en-us/azure/active-directory/authentication/tutorial-enable-azure-mfa?toc=/azure/active-directory/conditional-access/toc.json&bc=/azure/active-directory/conditional-access/breadcrumb/toc.json"
}
},
{
"stepNumber": 3,
"text": "3. Ensure that the per-user MFA configuration is turned off",
"actionUrl": {
"displayName": "Navigate to MFA settings.",
"url": "https://account.activedirectory.windowsazure.com/UserManagement/MfaSettings.aspx"
}
}
],
"impactedResources@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/recommendations('0cb31920-84b9-471f-a6fb-468c1a847088_Microsoft.Identity.IAM.Insights.TurnOffPerUserMFA')/impactedResources",
"impactedResources": []
}