更新 personname

命名空间:microsoft.graph

重要

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

更新用户配置文件中 personName 对象的属性。

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

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

权限

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

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

HTTP 请求

PATCH /me/profile/names/{id}
PATCH /users/{id | userPrincipalName}/profile/names/{id}

请求标头

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

请求正文

在请求正文中,提供应更新的相关字段的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。 为了获得最佳性能,请勿加入尚未更改的现有值。

下表显示了可在用户配置文件中的现有 personName 对象中更新的属性。

属性 类型 说明
allowedAudiences String 能够查看实体中包含的值的访问群体。 继承自 itemFacet。 可取值为:mefamilycontactsgroupMembersorganizationfederatedOrganizationseveryoneunknownFutureValue
displayName String 根据用户或其设备的区域设置,提供 firstName 和 lastName 的有序呈现。
第一 String 用户的名字。
推理 inferenceData 如果实体是由创建或修改应用程序推断的,则包含推理详细信息。 继承自 itemFacet
initials String 用户的首字母缩写。
languageTag String 包含采用 IETF BCP47 格式 (en-US、no-NB、en-AU) 语言的名称。
最后 String 用户的姓氏。
少女 String 用户的处女名称。
中间 String 用户的中间名。
昵称 String 用户的昵称。
发音 yomiPersonName 有关如何发音用户名的指南。
后缀 String 在用户名之后使用的指定符 (,例如:phD.)
title String 用于为用户名 (前缀的荣誉,例如:博士、先生、夫人、夫人 )

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和更新的 personName 对象。

示例

请求

下面是请求的示例。

PATCH https://graph.microsoft.com/beta/me/profile/names/{id}
Content-type: application/json

{
  "nickname": "Kesha"
}

响应

以下是响应示例。

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "displayName": "Innocenty Popov",
  "first": "Innocenty",
  "initials": "IP",
  "last": "Popov",
  "languageTag": "en-US",
  "maiden": null,
  "middle": null,
  "nickname": "Kesha",
  "suffix": null,
  "title": null,
  "pronunciation": {
    "displayName": "In-no ken-te ",
    "first": "In-no ken-te Pop-ov",
    "maiden": null,
    "middle": null,
    "last": "Pop-ov"
  }
}