phoneAuthenticationMethod 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

注册到用户的电话的表示形式。 此资源包括电话号码、电话类型,以及是否将电话配置为允许用户通过短信登录。

电话有三种类型之一:移动、备用移动或办公室。 用户可以为每种类型注册一个号码,并且必须拥有移动电话才能添加备用移动电话。 将手机用于多重身份验证 (MFA) 或自助服务密码重置 (SSPR) 时,移动电话为默认手机,备用移动电话为备份。

移动电话可用于短信和语音呼叫,具体取决于租户设置。

Office 电话只能接收语音呼叫,不能接收短信。

Methods

方法 返回类型 Description
List phoneAuthenticationMethod 读取此用户的所有 phoneAuthenticationMethod 对象的属性和关系。
获取 phoneAuthenticationMethod 读取 phoneAuthenticationMethod 对象的属性和关系。
更新 phoneAuthenticationMethod 更新 phoneAuthenticationMethod 对象。
删除 删除 phoneAuthenticationMethod 对象。
禁用短信登录 关闭用户的短信登录。
启用短信登录 为用户启用短信登录。

属性

属性 类型 说明
id String 注册到此用户的此电话的标识符。 只读。

id 的值是下列值之一:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - 其中 phoneTypealternateMobile
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - 其中 phoneTypeoffice
  • 3179e48a-750b-4051-897c-87b9720928f7 - 其中 phoneTypemobile
phoneNumber String 要发送文本或呼叫进行身份验证的电话号码。 电话数字使用格式"+ <country code> <number>x <extension> ",扩展是可选的。 例如,+1 5555551234 +1 5555551234x123 有效。 如果数字与所需格式不匹配,则创建/更新时将拒绝数字。
phoneType authenticationPhoneType 此电话的类型。 可能的值为: mobilealternateMobileoffice
smsSignInState authenticationMethodSignInState 电话是否可用于短信登录。 可能的值是 notSupported notAllowedByPolicy notEnabled :、、、、 phoneNumberNotUnique readynotConfigured unknownFutureValue

smsSignInState 值

SMS 登录状态属性提供有关电话号码是否已准备好通过短信登录的信息。 以下是可能的值。

说明
notSupported 此身份验证方法不支持主登录 - 例如,只能对用户的主移动电话号码(而非备用号码)启用登录。
notAllowedByPolicy 策略不启用此用户以将此方法用作主登录。
notConfigured 策略启用此用户以将此方法用作主登录,但需要执行其他操作来配置它。
phoneNumberNotUnique 此用户尝试将电话号码设置为主登录,但该号码不是唯一的,不能用作登录名。
ready 此身份验证方法已做好在主登录中的使用准备。
notEnabled 此登录方法未启用

关系

无。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}