更新 phoneAuthenticationMethod
本文内容
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新与 电话身份验证方法 关联的电话号码。
无法更改手机的类型。 若要更改手机的类型,请添加所需类型的新编号,然后删除具有原始类型的对象。
如果策略允许用户使用短信登录,并且 mobile
号码已更改,则系统会尝试注册该号码以便在该系统中使用。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
✅
✅
✅
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时 ,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型 。 要了解有关这些权限的详细信息,请参阅 权限参考 。
权限类型
最低特权权限
更高特权权限
委派(工作或学校帐户)
UserAuthenticationMethod.ReadWrite.All
UserAuthenticationMethod.ReadWrite
委派(个人 Microsoft 帐户)
不支持。
不支持。
应用程序
UserAuthenticationMethod.ReadWrite.All
不可用。
对于管理员对其他用户进行操作的委托方案,管理员至少需要身份验证管理员 或特权身份验证管理员 Microsoft Entra角色 。
用户无法更新自己的手机身份验证方法。
HTTP 请求
更新其他用户的电话身份验证方法。
PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}
对应于要更新的 phoneType 的值 phoneMethodId
是以下值之一:
b6332ec1-7057-4abe-9331-3d72feddfe41
alternateMobile
更新 phoneType 。
e37fc753-ff3b-4958-9484-eaa9425c82bc
office
更新 phoneType 。
3179e48a-750b-4051-897c-87b9720928f7
mobile
更新 phoneType 。
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
Content-type
application/json. 必需。
请求正文
在请求正文中,提供应更新的相关字段的值。 请求正文中未包含的现有属性将根据对其他属性值的更改重新计算。
属性
类型
说明
phoneNumber
String
要发短信或呼叫进行身份验证的电话号码。 电话号码使用格式“+<国家/地区代码><号码>x<分机>”,分机可选。 例如,+1 5555551234或 +1 555551234x123 有效。 如果数字与所需格式不匹配,则创建/更新时会拒绝这些数字。
phoneType
string
可能的值为: mobile
、 alternateMobile
或 office
。
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和更新的 phoneAuthenticationMethod 对象。
示例
请求
以下示例显示了一个请求。
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",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new PhoneAuthenticationMethod
{
PhoneNumber = "+1 2065555554",
PhoneType = AuthenticationPhoneType.Mobile,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.PhoneMethods["{phoneAuthenticationMethod-id}"].PatchAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta users authentication phone-methods patch --user-id {user-id} --phone-authentication-method-id {phoneAuthenticationMethod-id} --body '{\
"phoneNumber": "+1 2065555554",\
"phoneType": "mobile",\
}\
'
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodels.NewPhoneAuthenticationMethod()
phoneNumber := "+1 2065555554"
requestBody.SetPhoneNumber(&phoneNumber)
phoneType := graphmodels.MOBILE_AUTHENTICATIONPHONETYPE
requestBody.SetPhoneType(&phoneType)
phoneMethods, err := graphClient.Users().ByUserId("user-id").Authentication().PhoneMethods().ByPhoneAuthenticationMethodId("phoneAuthenticationMethod-id").Patch(context.Background(), requestBody, nil)
// 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);
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')
.version('beta')
.update(phoneAuthenticationMethod);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\PhoneAuthenticationMethod;
$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();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
phoneNumber = "+1 2065555554"
phoneType = "mobile"
}
Update-MgBetaUserAuthenticationPhoneMethod -UserId $userId -PhoneAuthenticationMethodId $phoneAuthenticationMethodId -BodyParameter $params
from msgraph import GraphServiceClient
from msgraph.generated.models.phone_authentication_method import PhoneAuthenticationMethod
graph_client = GraphServiceClient(credentials, scopes)
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)
响应
以下示例显示了相应的响应。
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"phoneNumber": "+1 2065555554",
"phoneType": "mobile",
"smsSignInState": "ready",
"id": "3179e48a-750b-4051-897c-87b9720928f7"
}