Get authentication method states
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.
Read the properties of a user's authentication states. Use this API to retrieve the following information:
- A user's signInPreferences (system-preferred MFA)
- A user's strongAuthenticationRequirements (per-user MFA)
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.
Permissions to read system-preferred MFA
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | UserAuthenticationMethod.Read | UserAuthenticationMethod.ReadWrite |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | UserAuthenticationMethod.Read | UserAuthenticationMethod.ReadWrite |
In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they 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.
- Global Reader
- Authentication Administrator
- Privileged Authentication Administrator
Permissions to read per-user MFA state
Permissions acting on self
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Policy.Read.All | Policy.ReadWrite.AuthenticationMethod |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
Permissions acting on others
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Policy.Read.All | Policy.ReadWrite.AuthenticationMethod |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Policy.Read.All | Policy.ReadWrite.AuthenticationMethod |
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.
- Global Reader
- Authentication Policy Administrator
HTTP request
To retrieve the sign-in preferences (system-preferred MFA) for a user:
GET /users/{id | userPrincipalName}/authentication/signInPreferences
To retrieve the per-user multifactor authentication state for the signed-in user:
GET /me/authentication/requirements
To retrieve the per-user multifactor authentication state for a user:
GET /users/{id | userPrincipalName}/authentication/requirements
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
For sign-in preferences: If successful, this method returns a 200 OK
response code and a signInPreferences object in the response body.
Examples
Example 1: Get a user's system-preferred MFA method
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences
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
{
"isSystemPreferredAuthenticationMethodEnabled": false,
"userPreferredMethodForSecondaryAuthentication": "push"
}
Example 2: Get a user's MFA state
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/requirements
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
{
"perUserMfaState": "enforced"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for