Skip to content

Latest commit

 

History

History
144 lines (102 loc) · 5.76 KB

File metadata and controls

144 lines (102 loc) · 5.76 KB
title Update phoneAuthenticationMethod
description Update a user's phone number associated with a phoneAuthenticationMethod object.
ms.localizationpriority medium
author luc-msft
ms.reviewer intelligentaccesspm
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 07/31/2025

Update phoneAuthenticationMethod

Namespace: microsoft.graph

Update a user's phone number associated with a phone authentication method object.

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 will attempt to register the number for use in that system.

Self-service operations aren't supported.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-apis-write-others]

HTTP request

Update another user's phone authentication method. Users can't update their own 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 the alternateMobile phoneType.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc to update the office phoneType.
  • 3179e48a-750b-4051-897c-87b9720928f7 to update the mobile 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 are not 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 or updating if they do not match the required format.
phoneType string The possible values are: mobile, alternateMobile, or office.

Response

If successful, this method returns a 204 No Content response code and an updated phoneAuthenticationMethod object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
Content-type: application/json

{
  "phoneNumber": "+1 2065555554",
  "phoneType": "mobile",
}

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

HTTP/1.1 204 No Content