Edit

Azure AD authentication methods API overview

  • Article

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.

Authentication methods are the ways that users authenticate in Azure Active Directory (AD). Authentication methods in Azure AD include password and phone (for example, SMS and voice calls), which are manageable in Microsoft Graph today, among many others such as FIDO2 security keys and the Microsoft Authenticator app. Authentication methods are used in primary, second-factor, and step-up authentication, and also in the self-service password reset (SSPR) process.

The authentication method APIs are used to manage a user's authentication methods. For example:

  • You can add a phone number to a user. The user can then use that phone number for SMS and voice call authentication if they're enabled to use it by policy.
  • You can update that number, or delete it from the user.
  • You can enable or disable the number for SMS sign-in.
  • You can reset a user's password.
  • You can retrieve details of a user's FIDO2 Security Key, and delete it if the user has lost the key.
  • You can retrieve details of a user's Microsoft Authenticator registration, and delete it if the user has lost the phone.
  • You can retrieve details of a user's Windows Hello for Business registration, and delete it if the user has lost the device.
  • You can add an email address to a user. The user can then use that email as part of the Self-Service Password Reset (SSPR) process.
  • You can update that email, or delete it from the user.

What authentication methods can be managed in Microsoft Graph?

Authentication method Description Examples
emailAuthenticationMethod An email address can be used by a user as part of the Self-Service Password Reset (SSPR) process. See a user's authentication email address. Add, update, or remove an email address to a user.
fido2AuthenticationMethod A FIDO2 Security Key can be used by a user to sign-in to Azure AD. Delete a lost FIDO2 Security Key.
microsoftAuthenticatorAuthenticationMethod Microsoft Authenticator can be used by a user to sign-in or perform multi-factor authentication to Azure AD Delete a Microsoft Authenticator authentication method.
passwordAuthenticationMethod A password is currently the default primary authentication method in Azure AD. Reset a user's password
phoneAuthenticationMethod A phone can be used by a user to authenticate using SMS or voice calls (as allowed by policy). See a user's authentication phone numbers. Add, update, or remove a phone number to a user. Enable or disable a primary mobile phone for SMS sign-in.
softwareOathAuthenticationMethod Allow users to perform multifactor authentication using an application that supports the OATH specification and provides a one-time code. Get and delete a software token assigned to a user.
temporaryaccesspassauthenticationmethod Temporary Access Pass is a time-limited passcode that serves as a strong credential and allows onboarding of passwordless credentials. Set a new Temporary Access Pass on a user.
windowsHelloForBusinessAuthenticationMethod Windows Hello for Business is a passwordless sign-in method on Windows devices. See devices where a user has enabled Windows Hello for Business sign-in. Delete a Windows Hello for Business credential.
passwordlessmicrosoftauthenticatorauthenticationmethod (deprecated) Microsoft Authenticator Passwordless Phone Sign-in can be used by a user to sign-in to Azure AD Delete a Passwordless Phone Sign-in authentication method.

The following authentication methods are not yet supported in Microsoft Graph beta.

Authentication method Description Examples
Default method Represents the method the user has selected as default for performing multi-factor authentication. Change a user's default MFA method.
NOTE: Managing the details of the default method is currently supported only through the MSOL Get-MsolUser and Set-MsolUser cmdlets, using the StrongAuthenticationMethods property.
Hardware token Allow users to perform multifactor authentication using a physical device that provides a one-time code. Get a hardware token assigned to a user.
Require re-register MFA A control that requires that when user signs in next time and MFA is required, they're requested to set up a new MFA authentication method. NOTE: This feature is replaced by the individual authentication method APIs listed above. These can be used to delete a user's existing registered authentication methods; once the user has no more methods, they'll be prompted to register the next time they sign in where strong authentication is required (the user can also register at any time using MySecurityInfo). This can be done using the Azure AD admin UX, the Microsoft Graph APIs, and the Microsoft Graph Powershell SDK.
The legacy version of this feature is currently supported only through the MSOLSet-MsolUser cmdlet, using the StrongAuthenticationMethods property.
Security questions and answers Allow users to validate their identity when performing a self-service password reset. Delete a security question a user registered.

Next steps

  • Review the authentication method types and their various methods.
  • Try the API in Graph Explorer.