命名空间:microsoft.graph
更新与 电话身份验证方法 对象关联的用户的电话号码。
无法更改手机的类型。 若要更改手机的类型,请添加所需类型的新编号,然后删除具有原始类型的对象。
如果策略允许用户使用短信登录,并且 mobile 号码已更改,系统将尝试注册该号码以便在该系统中使用。
不支持自助服务作。
此 API 可用于以下国家级云部署。
| 全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 | 
| ✅ | ✅ | ✅ | ❌ | 
权限
为此 API 选择标记为最低特权的权限。 
              只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
| 权限类型 | 最低特权权限 | 更高特权权限 | 
| 委派(工作或学校帐户) | UserAuthMethod-Phone.ReadWrite | UserAuthenticationMethod.ReadWrite.All、UserAuthMethod-Phone.ReadWrite.All、UserAuthenticationMethod.ReadWrite | 
| 委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 | 
| 应用程序 | UserAuthenticationMethod.ReadWrite.All | UserAuthMethod-Phone.ReadWrite.All | 
重要
在具有工作或学校帐户的委托方案中,如果已登录用户对其他用户进行作,则必须为他们分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色。
 
HTTP 请求
更新其他用户的电话身份验证方法。 用户无法更新自己的手机身份验证方法。
PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}
对应于要更新的 phoneType 的值 phoneMethodId 是以下值之一:
- 
              b6332ec1-7057-4abe-9331-3d72feddfe41alternateMobile更新 phoneType。
- 
              e37fc753-ff3b-4958-9484-eaa9425c82bcoffice更新 phoneType。
- 
              3179e48a-750b-4051-897c-87b9720928f7mobile更新 phoneType。
| 名称 | 说明 | 
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 | 
| Content-type | application/json. 必需。 | 
请求正文
在请求正文中,提供应更新的相关字段的值。 请求正文中未包含的现有属性将根据对其他属性值的更改重新计算。
| 属性 | 类型 | 说明 | 
| phoneNumber | String | 要发短信或呼叫进行身份验证的电话号码。 电话号码使用 格式 +{country code} {number}x{extension},扩展名可选。 例如,+1 5555551234或+1 5555551234x123有效。 如果数字与所需格式不匹配,则创建或更新时,将拒绝这些数字。 | 
| phoneType | string | 可能的值为: mobile、alternateMobile或office。 | 
响应
如果成功,此方法在响应正文中返回响应 204 No Content 代码和更新的 phoneAuthenticationMethod 对象。
示例
请求
以下示例显示了一个请求。
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",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new PhoneAuthenticationMethod
{
	PhoneNumber = "+1 2065555554",
	PhoneType = AuthenticationPhoneType.Mobile,
};
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.PhoneMethods["{phoneAuthenticationMethod-id}"].PatchAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)
requestBody := graphmodels.NewPhoneAuthenticationMethod()
phoneNumber := "+1 2065555554"
requestBody.SetPhoneNumber(&phoneNumber) 
phoneType := graphmodels.MOBILE_AUTHENTICATIONPHONETYPE 
requestBody.SetPhoneType(&phoneType) 
// To initialize your graphClient, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
phoneMethods, err := graphClient.Users().ByUserId("user-id").Authentication().PhoneMethods().ByPhoneAuthenticationMethodId("phoneAuthenticationMethod-id").Patch(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
PhoneAuthenticationMethod phoneAuthenticationMethod = new PhoneAuthenticationMethod();
phoneAuthenticationMethod.setPhoneNumber("+1 2065555554");
phoneAuthenticationMethod.setPhoneType(AuthenticationPhoneType.Mobile);
PhoneAuthenticationMethod result = graphClient.users().byUserId("{user-id}").authentication().phoneMethods().byPhoneAuthenticationMethodId("{phoneAuthenticationMethod-id}").patch(phoneAuthenticationMethod);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
const options = {
	authProvider,
};
const client = Client.init(options);
const phoneAuthenticationMethod = {
  phoneNumber: '+1 2065555554',
  phoneType: 'mobile',
};
await client.api('/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7')
	.update(phoneAuthenticationMethod);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\PhoneAuthenticationMethod;
use Microsoft\Graph\Generated\Models\AuthenticationPhoneType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PhoneAuthenticationMethod();
$requestBody->setPhoneNumber('+1 2065555554');
$requestBody->setPhoneType(new AuthenticationPhoneType('mobile'));
$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->phoneMethods()->byPhoneAuthenticationMethodId('phoneAuthenticationMethod-id')->patch($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
	phoneNumber = "+1 2065555554"
	phoneType = "mobile"
}
Update-MgUserAuthenticationPhoneMethod -UserId $userId -PhoneAuthenticationMethodId $phoneAuthenticationMethodId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.phone_authentication_method import PhoneAuthenticationMethod
from msgraph.generated.models.authentication_phone_type import AuthenticationPhoneType
# To initialize your graph_client, see https://free.blessedness.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PhoneAuthenticationMethod(
	phone_number = "+1 2065555554",
	phone_type = AuthenticationPhoneType.Mobile,
)
result = await graph_client.users.by_user_id('user-id').authentication.phone_methods.by_phone_authentication_method_id('phoneAuthenticationMethod-id').patch(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息,请参阅 SDK 文档。
 
响应
以下示例显示了相应的响应。
HTTP/1.1 204 No Content