personname を更新する

[アーティクル]
02/01/2024

名前空間: microsoft.graph

重要

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

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

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

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

アクセス許可

この 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 から継承されます。可能な値は、`me`、`family`、`contacts`、`groupMembers`、`organization`、`federatedOrganizations`、`everyone`、`unknownFutureValue` です。
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	ユーザーの名前の前に付けるために使用される敬語 (たとえば、Dr、Sir、Madam、Mrs など)。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された personName オブジェクトを返します。

例

要求

要求の例を次に示します。

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

{
  "nickname": "Kesha"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new PersonName
{
	Nickname = "Kesha",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Profile.Names["{personName-id}"].PatchAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta users profile names patch --user-id {user-id} --person-name-id {personName-id} --body '{\
  "nickname": "Kesha"\
}\
\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewPersonName()
nickname := "Kesha"
requestBody.SetNickname(&nickname) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
names, err := graphClient.Me().Profile().Names().ByPersonNameId("personName-id").Patch(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

PersonName personName = new PersonName();
personName.setNickname("Kesha");
PersonName result = graphClient.me().profile().names().byPersonNameId("{personName-id}").patch(personName);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const personName = {
  nickname: 'Kesha'
};

await client.api('/me/profile/names/{id}')
	.version('beta')
	.update(personName);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\PersonName;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PersonName();
$requestBody->setNickname('Kesha');

$result = $graphServiceClient->me()->profile()->names()->byPersonNameId('personName-id')->patch($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.People

$params = @{
	nickname = "Kesha"
}

# A UPN can also be used as -UserId.
Update-MgBetaUserProfileName -UserId $userId -PersonNameId $personNameId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.person_name import PersonName
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PersonName(
	nickname = "Kesha",
)

result = await graph_client.me.profile.names.by_person_name_id('personName-id').patch(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

応答の例を下に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
  }
}

次の方法で共有

personname を更新する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

その他のリソース