人物名を更新する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

ユーザーのプロファイルの personName オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) User.ReadWrite AgentIdUser.ReadWrite.All、AgentIdUser.ReadWrite.IdentityParentedBy、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 文字列 エンティティに含まれる値を表示できる対象ユーザー。 itemFacet から継承されます。 指定できる値は、 me、 family、 contacts、 groupMembers、 organization、 federatedOrganizations、 everyone、 unknownFutureValue です。
displayName 文字列 ユーザーまたはデバイスのロケールに応じて、firstName と lastName の順序付きレンダリングを提供します。
first 文字列 ユーザーの名。
推論 inferenceData エンティティが作成または変更するアプリケーションによって推論される場合の推論の詳細が含まれます。 itemFacet から継承されます。
initials String ユーザーのイニシャル。
languageTag 文字列 IETF BCP47 形式に従う言語の名前 (en-US、no-NB、en-AU) が含まれます。
姓 文字列 ユーザーの姓。
乙女 文字列 ユーザーの旧姓。
middle 文字列 ユーザーのミドル ネーム。
nickname 文字列 ユーザーのニックネーム。
発音 yomiPersonName ユーザー名の発音のガイダンス。
サフィックス 文字列 ユーザーの名前の後に使用される指定子 (例: PhD)
title String ユーザーの名前の接頭辞として使われる敬語 (例: Dr、Sir、Madam、Mrs.)

応答

成功した場合、このメソッドは応答本文で 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"
  }
}