更新 emailAuthenticationMethodConfiguration

命名空间:microsoft.graph

重要

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

更新 emailAuthenticationMethodConfiguration 对象的属性,该对象表示Microsoft Entra租户的电子邮件 OTP 身份验证方法策略

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Policy.ReadWrite.AuthenticationMethod 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Policy.ReadWrite.AuthenticationMethod 不可用。

在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 身份验证策略管理员 是此操作支持的最低特权角色。

HTTP 请求

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中, 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
allowExternalIdToUseEmailOtp externalEmailOtpState 确定外部用户是否可以使用电子邮件 OTP 进行身份验证。 可能的值是:defaultenableddisabledunknownFutureValue
excludeTargets excludeTarget 集合 组策略中排除的用户。
state authenticationMethodState 指示是否启用此身份验证方法。 可取值为:enableddisabled

注意: 必须在请求正文中包含 @odata.type 值为 #microsoft.graph.emailAuthenticationMethodConfiguration 的属性。

响应

如果成功,此方法返回 204 No Content 响应代码。 它不会在响应正文中返回任何内容。

示例

请求

PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/email
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
  "allowExternalIdToUseEmailOtp": "disabled",
}

响应

HTTP/1.1 204 NO CONTENT