phoneAuthenticationMethod resource type

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.

A representation of a phone registered to a user. This resource includes the phone number, the phone type, and whether the phone is configured for the user to sign in via SMS.

A phone has one of three types: mobile, alternate mobile, or office. A user can have one number registered for each type, and must have a mobile phone before an alternate mobile phone is added. When using a phone for multi-factor authentication (MFA) or self-service password reset (SSPR), the mobile phone is the default and the alternate mobile phone is the backup.

Mobile phones can be used for both SMS and voice calls, depending on the tenant settings.

An office phone can only receive voice calls, not SMS messages.

Methods

Method Return Type Description
List phoneAuthenticationMethod Read properties and relationships of all of this user's phoneAuthenticationMethod objects.
Get phoneAuthenticationMethod Read properties and relationships of phoneAuthenticationMethod object.
Update phoneAuthenticationMethod Update phoneAuthenticationMethod object.
Delete None Delete phoneAuthenticationMethod object.
Disable SMS signin None Turn off SMS sign-in for a user.
Enable SMS signin None Turn on SMS sign-in for a user.

Properties

Property Type Description
id String The identifier of this phone registered to this user. Read-only.

The value of id is one of the following:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - where phoneType is alternateMobile.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - where phoneType is office.
  • 3179e48a-750b-4051-897c-87b9720928f7 - where phoneType is mobile.
phoneNumber String The phone number to text or call for authentication. Phone numbers use the format "+<country code> <number>x<extension>", with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating/updating if they do not match the required format.
phoneType authenticationPhoneType The type of this phone. Possible values are: mobile, alternateMobile, or office.
smsSignInState authenticationMethodSignInState Whether a phone is ready to be used for SMS sign-in or not. Possible values are: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, ready, or notConfigured, unknownFutureValue.

smsSignInState values

The SMS sign-in state property gives information about whether or not a phone number is ready to sign in via SMS. The following are the possible values.

Value Description
notSupported Primary sign-in not supported on this authentication method - for example, sign-in can be enabled only on a user's primary mobile number, not the alternate number.
notAllowedByPolicy This user isn't enabled by policy to use this method as a primary sign-in.
notConfigured This user is enabled by policy to use this method as primary sign-in but needs to take additional action to configure it.
phoneNumberNotUnique This user attempted to set up a phone number as primary sign-in but the number was not unique and can't be used as a sign-in name.
ready This authentication method is ready for use in primary sign-in.
notEnabled This sign-in method is not enabled

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}