phoneAuthenticationMethod 资源类型

命名空间:microsoft.graph

重要

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

向用户注册的手机的表示形式。 此资源包括电话号码、电话类型以及是否为用户配置了电话以通过短信登录。

电话具有以下三种类型之一:移动电话、备用手机或办公室电话。 用户可以为每种类型注册一个号码,并且在添加备用移动电话之前必须拥有移动电话。 当使用手机进行多重身份验证 (MFA) 或 SSPR) (自助式密码重置时,移动电话是默认的,备用移动电话是备用移动电话。

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

办公电话只能接听语音呼叫,不能接听短信。

这是继承自 authenticationMethod 资源类型的派生类型。

方法

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

属性

属性 类型 说明
createdDateTime DateTimeOffset 向用户注册身份验证方法的日期和时间。 只读。 可选。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。
lastUsedDateTime DateTimeOffset 用户上次使用身份验证方法的日期和时间。 只读。 可选。 如果身份验证方法未填充此可选值,则表示 null 此可选值。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 继承自 authenticationMethod。
id String 向此用户注册的此手机的标识符。 只读。

ID 的值是下列值之一:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - 其中 phoneType 是 alternateMobile。
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - 其中 phoneType 是 office。
  • 3179e48a-750b-4051-897c-87b9720928f7 - 其中 phoneType 是 mobile。
phoneNumber String 要发送短信或拨打进行身份验证的电话号码。 电话号码使用“+<国家/地区代码>><x<分机>”格式,分机可选。 例如,+1 5555551234 或 +1 5555551234x123 有效。 如果数字与所需的格式不匹配,则在创建/更新时将被拒绝。
phoneType authenticationPhoneType 此手机的类型。 可能的值为:、alternateMobile、或office。 mobile
smsSignInState authenticationMethodSignInState 手机是否已准备好用于短信登录。 可能的值为:notSupported、、notAllowedByPolicynotEnabled、readyphoneNumberNotUnique、或 。 unknownFutureValuenotConfigured

authenticationPhoneType 值

手机可以有三种类型,以下是可能的值。

值 说明
mobile 可用于短信和语音呼叫的主要移动电话。
alternateMobile 备用或备用移动电话,仅可用于语音呼叫。
办公室 办公室电话或座机,仅可用于语音呼叫。

authenticationMethodSignInState 值

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

值 说明
notSupported 此身份验证方法不支持主登录 - 例如,只能在用户的主要手机号码上启用登录,而不能在备用号码上启用登录。
notAllowedByPolicy 策略未启用此用户使用此方法作为主要登录。
未配置 策略允许此用户使用此方法作为主要登录,但需要执行进一步的操作来配置它。
phoneNumberNotUnique 此用户尝试将电话号码设置为主要登录,但该号码并不唯一,不能用作登录名。
就绪 此身份验证方法已可用于主登录。
未启用 未启用此登录方法

关系

无。

JSON 表示形式

以下 JSON 表示形式显示资源类型。

{
  "@odata.type": "#microsoft.graph.phoneAuthenticationMethod",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}