passwordAuthenticationMethod: resetPassword

命名空间:microsoft.graph

重要

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

为与 密码身份验证方法 对象关联的密码启动重置。 这只能由具有适当权限的管理员执行,不能在用户自己的帐户上执行。

若要在 Azure AD B2C 中重置用户密码,请使用更新用户 API 操作并更新 passwordProfile>forceChangePasswordNextSignIn 对象。

此流将新密码写入 Microsoft Entra ID,并在使用密码写回进行配置时将其推送到本地 Active Directory。 管理员可以提供新密码或让系统生成密码。 系统会提示用户在下次登录时更改密码。

此重置是一个长时间运行的操作,将返回一个带有链接的 Location 标头,调用方可以在其中定期检查重置操作的状态。

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

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

权限

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

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

重要

对于使用工作或学校帐户的委派访问权限,必须为登录用户分配受支持的 Microsoft Entra 角色或授予此操作所需权限的自定义角色。 此操作支持以下内置角色,这些角色仅提供所需的最小权限:

  • 身份验证管理员
  • 特权身份验证管理员

当用户管理自己的身份验证方法时,如果用户在当前会话中进行身份验证超过 10 分钟,系统会提示他们完成多重身份验证 (MFA) 。

具有 用户管理员、 支持人员管理员或 密码管理员 角色的管理员还可以为非管理员用户和有限的管理员角色集重置密码,如 谁可以重置密码中所定义。

HTTP 请求

由 引用的 {passwordMethods-id}密码身份验证方法的 ID 始终 28c10230-6103-485e-b985-444c60001490为 。

POST /users/{id | userPrincipalName}/authentication/methods/{passwordMethods-id}/resetPassword

请求标头

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

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
newPassword String 新密码。 对于具有混合密码方案的租户是必需的。 如果省略仅限云的密码,系统将返回系统生成的密码。 这是一个没有其他编码的 Unicode 字符串。 在接受之前,将针对租户的禁止密码系统进行验证,并且必须遵守租户的云和/或本地密码要求。

响应

如果调用方在请求正文中提供了密码,则此方法将返回响应 202 Accepted 代码,而不返回响应正文。 响应可能还包括带有 URL 的位置标头,用于检查重置操作的状态。

如果调用方使用了系统生成的密码选项,则此方法将在包含 Microsoft 生成密码的响应正文中返回 202 Accepted 响应代码和 passwordResetResponse 对象。 响应可能还包括带有 URL 的位置标头,用于检查重置操作的状态。

响应标头

名称 说明
位置 要调用以检查操作状态的 URL。 必填。
重试后 持续时间(秒)。 可选。

示例

示例 1:用户提交的密码

下面的示例演示了如何在调用方提交密码时调用此 API。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword
Content-type: application/json

{
    "newPassword": "Cuyo5459"
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Content-type: application/json
Location: https://graph.microsoft.com/beta/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/88e7560c-9ebf-435c-8089-c3998ac1ec51?aadgdc=DUB02P&aadgsu=ssprprod-a

示例 2:系统生成的密码

下面的示例演示了如何在调用方未提交密码时调用此 API。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword

{

}

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 202 ACCEPTED
Location: https://graph.microsoft.com/beta/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/77bafe36-3ac0-4f89-96e4-a4a5a48da851?aadgdc=DUB02P&aadgsu=ssprprod-a
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.passwordResetResponse",
    "newPassword": "Cuyo5459"
}