phoneAuthenticationMethod 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
向用户注册的电话的表示形式。 此资源包括电话号码、电话类型以及是否为用户配置了电话以通过短信登录。
手机有三种类型之一：移动、备用移动或办公室。 用户可以为每个类型注册一个号码，并且必须在添加备用移动电话之前拥有一个移动电话。 使用手机进行多重身份验证 (MFA) 或自助密码重置 (SSPR) 时，默认为移动电话，备用移动电话为备份。
主移动电话可用于短信和语音呼叫，具体取决于租户设置。
办公电话只能接听语音呼叫，不能接听短信。
这是继承自 authenticationMethod 资源类型的派生类型。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | phoneAuthenticationMethod | 读取此用户的所有手机身份验证方法对象的属性和关系。 |
| Get | phoneAuthenticationMethod | 读取 phoneAuthenticationMethod 对象的属性和关系。 |
| 添加 | phoneAuthenticationMethod | 创建用户的 phoneAuthenticationMethod 对象。 |
| 更新 | phoneAuthenticationMethod | 更新 phoneAuthenticationMethod 对象。 |
| 删除 | None | 删除 phoneAuthenticationMethod 对象。 |
| 禁用短信登录 | None | 关闭用户的短信登录。 |
| 启用短信登录 | None | 为用户启用短信登录。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| createdDateTime | DateTimeOffset | 向用户注册身份验证方法的日期和时间。 只读。 可选。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| id | String | 注册到此用户的此手机的标识符。 只读。 ID 的值为以下值之一：
|
| phoneNumber | String | 要发短信或呼叫进行身份验证的电话号码。 电话号码使用格式“+<国家/地区代码><号码>x<分机>”，分机可选。 例如，+1 5555551234或 +1 555551234x123 有效。 如果数字与所需格式不匹配，则创建/更新时会拒绝这些数字。 |
| phoneType | authenticationPhoneType | 此手机的类型。 可能的值为： mobile、 alternateMobile或 office。 |
| smsSignInState | authenticationMethodSignInState | 手机是否已准备好用于短信登录。 可能的值为：notSupported、、notAllowedByPolicy、notEnabledphoneNumberNotUnique、ready、 或 。 unknownFutureValuenotConfigured |
authenticationPhoneType 值
手机可以有三种类型，以下是可能的值。
| 值 | 说明 |
|---|---|
| mobile | 主要移动电话，可用于短信和语音呼叫。 |
| alternateMobile | 备用或备用移动电话，仅适用于语音呼叫。 |
| 办公室 | 办公室电话或座机，仅适用于语音呼叫。 |
authenticationMethodSignInState 值
SMS 登录状态属性提供有关电话号码是否已准备好通过短信登录的信息。 下面是可能的值。
| 值 | 说明 |
|---|---|
| notSupported | 此身份验证方法不支持主登录 - 例如，只能在用户的主要手机号码上启用登录，而不能在备用号码上启用登录。 |
| notAllowedByPolicy | 策略未允许此用户使用此方法作为主登录。 |
| notConfigured | 策略允许此用户使用此方法作为主要登录，但需要采取进一步操作来配置它。 |
| phoneNumberNotUnique | 此用户尝试将电话号码设置为主要登录，但该号码不唯一，不能用作登录名称。 |
| 准备 | 此身份验证方法已准备好在主登录中使用。 |
| notEnabled | 未启用此登录方法 |
关系
无。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@odata.type": "#microsoft.graph.phoneAuthenticationMethod",
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"phoneNumber": "String",
"phoneType": "string",
"smsSignInState": "string"
}