Update phoneAuthenticationMethod
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 phone number associated with a phone authentication method.
You can't change a phone's type. To change a phone's type, add a new number of the desired type and then delete the object with the original type.
If a user is enabled by policy to use SMS to sign in and the mobile
number is changed, the system attempts to register the number for use in that system.
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.All | UserAuthenticationMethod.ReadWrite |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | UserAuthenticationMethod.ReadWrite.All | Not available. |
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.
Users can't update their own phone authentication method.
HTTP request
Update another user's phone authentication method.
PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}
The value of phoneMethodId
corresponding to the phoneType to update is one of the following:
b6332ec1-7057-4abe-9331-3d72feddfe41
to update thealternateMobile
phoneType.e37fc753-ff3b-4958-9484-eaa9425c82bc
to update theoffice
phoneType.3179e48a-750b-4051-897c-87b9720928f7
to update themobile
phoneType.
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 the values for relevant fields that should be updated. Existing properties that aren't included in the request body will be recalculated based on changes to other property values.
Property | Type | Description |
---|---|---|
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 don't match the required format. |
phoneType | string | Possible values are: mobile , alternateMobile , or office . |
Response
If successful, this method returns a 200 OK
response code and an updated phoneAuthenticationMethod object in the response body.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
Content-type: application/json
{
"phoneNumber": "+1 2065555554",
"phoneType": "mobile",
}
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
{
"phoneNumber": "+1 2065555554",
"phoneType": "mobile",
"smsSignInState": "ready",
"id": "3179e48a-750b-4051-897c-87b9720928f7"
}
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