authenticationStrengthPolicy: usage

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.

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.

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) Policy.Read.All Policy.ReadWrite.AuthenticationMethod, Policy.ReadWrite.ConditionalAccess
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.Read.All Policy.ReadWrite.AuthenticationMethod, Policy.ReadWrite.ConditionalAccess

In delegated scenarios with work or school accounts, the signed-in user must 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.

  • Conditional Access administrator
  • Security Administrator
  • Security Reader

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.

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

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"]
      }
  }]
}