Skip to content

authenticationstrengthpolicy-usage.md

Latest commit

 

History

History
129 lines (101 loc) · 5.07 KB

authenticationstrengthpolicy-usage.md

File metadata and controls

129 lines (101 loc) · 5.07 KB
title authenticationStrengthPolicy: usage
description The`usage function allows the caller to see which Conditional Access policies reference a specified authentication strength policy
author InbarckMS
ms.reviewer conditionalaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/05/2024

authenticationStrengthPolicy: usage

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

The usage function allows the caller to see which Conditional Access policies reference a specified authentication strength policy. The policies are returned in two collections, one containing Conditional Access policies that require an MFA claim and the other containing Conditional Access policies that do not require such a claim. Policies in the former category are restricted in what kinds of changes may be made to them to prevent undermining the MFA requirement of those policies.

[!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-authenticationstrength-apis-read]

HTTP request

GET /policies/authenticationStrengthPolicies/{authenticationStrengthPolicyId}/usage

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 an authenticationStrengthUsage complex type in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/policies/authenticationStrengthPolicies/{authenticationStrengthPolicyId}/usage

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

[!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

{
  "mfa": [{
      "displayName": "Conditional Access Policy 1",
      "id": "a26dbede-a6c0-4156-92e1-6c86dd7bc561",
      "grantControls": {
        "authenticationStrength": {"id": "00000000-0000-0000-0000-000000000003"},
        "controls": ["MfaAndChangePassword"]
      }
    }],
  "none": [{
      "displayName": "Conditional Access Policy 2",
      "id": "5d7d5a7f-dd35-412b-a18d-5411d8eafe8f",
      "grantControls": {
        "authenticationStrength": {"id": "00000000-0000-0000-0000-000000000003"},
        "controls": ["RequireCompliantDevice"]
      }
  }]
}