Update 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.
Update the properties of a user's authentication method states. Use this API to update the following information:
- A user's signInPreferences
- A user's strongAuthenticationRequirements
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) | UserAuthenticationMethod.ReadWrite | UserAuthenticationMethod.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | UserAuthenticationMethod.ReadWrite | UserAuthenticationMethod.ReadWrite.All |
For delegated scenarios where an admin is acting on another user, the administrator needs at least the Authentication Administrator or Privileged Authentication Administrator Microsoft Entra role.
HTTP request
To update the sign-in preferences for a user:
PATCH /users/{id | userPrincipalName}/authentication/signInPreferences
To update the per-user multifactor authentication state for a user:
PATCH /users/{id | userPrincipalName}/authentication/requirements
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property | Type | Description |
---|---|---|
isSystemPreferredAuthenticationMethodEnabled | Boolean | Indicates whether the credential preferences of the system are enabled. |
userPreferredMethodForSecondaryAuthentication | userDefaultAuthenticationMethodType | The default second-factor method used by the user when signing in. If a user is enabled for system-preferred authentication, then this value is ignored except for a few scenarios where a user is authenticating via NPS extension or ADFS adapter. Possible values are push , oath , voiceMobile , voiceAlternateMobile , voiceOffice , sms , and unknownFutureValue |
perUserMfaState | perUserMfaState | The user's state for per-user multifactor authentication. Possible values are enforced , enabled and disabled . |
Response
If successful, this method returns a 204 No Content
response code.
Examples
Example 1: Update a user's default MFA method
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences
Content-Type: application/json
{
"userPreferredMethodForSecondaryAuthentication": "oath"
}
Response
HTTP/1.1 204 No Content
Example 2: Update a user's MFA state
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/requirements
Content-Type: application/json
{
"perUserMfaState": "disabled"
}
Response
HTTP/1.1 204 No Content
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro