ユーザーを更新するUpdate user

名前空間: microsoft.graphNamespace: microsoft.graph

ユーザー オブジェクトのプロパティを更新します。Update the properties of a user object. メンバーまたはゲスト ユーザーは、管理者の役割なしで既定のアクセス許可を使用して、すべてのプロパティを更新できるわけではありません。Not all properties can be updated by Member or Guest users with their default permissions without Administrator roles. メンバーとゲストの既定のアクセス許可を比較して、管理できるプロパティを確認します。Compare member and guest default permissions to see properties they can manage.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) User.ReadWrite、User.ReadWrite.All、User.ManageIdentities.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllUser.ReadWrite, User.ReadWrite.All, User.ManageIdentities.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) User.ReadWriteUser.ReadWrite
アプリケーションApplication User.ReadWrite.All、User.ManageIdentities.All、Directory.ReadWrite.AllUser.ReadWrite.All, User.ManageIdentities.All, Directory.ReadWrite.All

注意

  • passwordProfile プロパティを更新するときは、次のアクセス許可が必要です。Directory.AccessAsUser.All。When updating the passwordProfile property, the following permission is required: Directory.AccessAsUser.All.
  • 他のユーザーの businessPhonesmobilePhone、または otherMails のプロパティの更新を許可されているのは、管理者以外のユーザーまたは次のロールのいずれかを割り当てられたユーザーのみになります。ディレクトリ閲覧者、ゲスト招待元、メッセージ センター閲覧者およびレポート閲覧者。Updating another user's businessPhones, mobilePhone, or otherMails property is only allowed on users who are non-administrators or assigned one of the following roles: Directory Readers, Guest Inviter, Message Center Reader, and Reports Reader. 詳細については、「Azure AD 組み込みロール」のヘルプデスク (パスワード) 管理者を参照してください。For more details, see Helpdesk (Password) Administrator in Azure AD built-in roles. User.ReadWrite.All または Directory.ReadWrite.All の委任またはアプリケーションのアクセス許可のいずれかが与えられているアプリの場合、これに該当します。This is the case for apps granted either the User.ReadWrite.All or Directory.ReadWrite.All delegated or application permissions.
  • 個人の Microsoft アカウントで User.ReadWrite 委任されたアクセス許可を使用してプロファイルを更新するには、個人の Microsoft アカウントを AAD テナントに関連付ける必要があります。Your personal Microsoft account must be tied to an AAD tenant to update your profile with the User.ReadWrite delegated permission on a personal Microsoft account.
  • identities プロパティを更新するには、User.ManageIdentities.All アクセス許可が必要です。Updating the identities property requires the User.ManageIdentities.All permission. また、B2C ローカル アカウントを既存の user オブジェクトに追加することは、その user オブジェクトにローカル アカウント ID が既に含まれている場合を除き、許可されていません。Also, adding a B2C local account to an existing user object is not allowed, unless the user object already contains a local account identity.

HTTP 要求HTTP request

PATCH /users/{id | userPrincipalName}

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

プロパティProperty 種類Type 説明Description
aboutMeaboutMe StringString ユーザーが自分自身について記述する、フリー フォームのテキスト入力フィールド。A freeform text entry field for the user to describe themselves.
accountEnabledaccountEnabled BooleanBoolean アカウントが有効な場合は true であり、それ以外の場合は false です。true if the account is enabled; otherwise, false. このプロパティは、ユーザーの作成時に必要です。This property is required when a user is created.
ageGroupageGroup ageGroupageGroup ユーザーの年齢グループを設定します。Sets the age group of the user. 使用できる値: nullminornotAdult、および adultAllowed values: null, minor, notAdult and adult. 詳細については、「法的年齢グループ プロパティの定義」を参照してください。Refer to the legal age group property definitions for further information.
birthdaybirthday DateTimeOffsetDateTimeOffset ユーザーの誕生日。The birthday of the user. Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、必ず UTC 時間です。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
businessPhonesbusinessPhones String collectionString collection ユーザーの電話番号。注:文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property.
citycity StringString ユーザーがいる都市。The city in which the user is located.
companyNamecompanyName StringString ユーザーが関連付けられている会社名。The company name which the user is associated. このプロパティは、外部ユーザーが所属する会社を記述するのに役立ちます。This property can be useful for describing the company that an external user comes from. 会社名の長さの上限は 64 文字です。The maximum length of the company name is 64 characters.
consentProvidedForMinorconsentProvidedForMinor consentProvidedForMinorconsentProvidedForMinor 未成年者について同意を得ているかどうかを設定します。Sets whether consent has been obtained for minors. 使用できる値: nullgranteddenied、および notRequiredAllowed values: null, granted, denied and notRequired. 詳細については、「法的年齢グループ プロパティの定義」を参照してください。Refer to the legal age group property definitions for further information.
countrycountry StringString ユーザーがいる国/地域。たとえば、USUK です。The country/region in which the user is located; for example, US or UK.
departmentdepartment StringString ユーザーが働いている部門の名前。The name for the department in which the user works.
displayNamedisplayName StringString アドレス帳に表示されるユーザーの名前。The name displayed in the address book for the user. これは通常、ユーザーの名前、ミドルネームのイニシャル、姓の組み合わせです。This is usually the combination of the user's first name, middle initial and last name. このプロパティはユーザーの作成時に必須です。更新時にクリアすることはできません。This property is required when a user is created and it cannot be cleared during updates. $filter$orderby をサポートします。Supports $filter and $orderby.
employeeIdemployeeId StringString 組織によりユーザーに割り当てられた従業員 ID。The employee identifier assigned to the user by the organization.
givenNamegivenName StringString ユーザーの名。The given name (first name) of the user.
hireDatehireDate DateTimeOffsetDateTimeOffset ユーザーの採用日付。The hire date of the user. Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
interestsinterests String collectionString collection ユーザーが自分の関心事を記述する一覧。A list for the user to describe their interests.
jobTitlejobTitle StringString ユーザーの役職。The user’s job title.
mailmail StringString ユーザーの SMTP アドレス (たとえば、jeff@contoso.onmicrosoft.com)。The SMTP address for the user, for example, jeff@contoso.onmicrosoft.com. このプロパティを変更すると、その値が SMTP アドレスとして表示されるように、ユーザーの proxyAddresses コレクションも更新されます。Changes to this property will also update the user's proxyAddresses collection to include the value as a SMTP address.

$filter をサポートしています。Supports $filter.
mailNicknamemailNickname StringString ユーザーの電子メール エイリアス。The mail alias for the user. ユーザーの作成時に、このプロパティを指定する必要があります。This property must be specified when a user is created.
mobilePhonemobilePhone StringString ユーザーの主な携帯電話の番号。The primary cellular telephone number for the user.
mySitemySite StringString ユーザーの個人用サイトの URL。The URL for the user's personal site.
officeLocationofficeLocation StringString ユーザーの勤務先の場所。The office location in the user's place of business.
onPremisesImmutableIdonPremisesImmutableId StringString このプロパティは、オンプレミスの Active Directory ユーザー アカウントを Azure AD ユーザー オブジェクトに関連付けるために使用します。This property is used to associate an on-premises Active Directory user account to their Azure AD user object. Graph で新しいユーザー アカウントを作成するとき、ユーザーの userPrincipalName (UPN) プロパティにフェデレーション ドメインを使用する場合は、このプロパティを指定する必要があります。This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user’s userPrincipalName (UPN) property. 重要: $_ の文字は、このプロパティを指定するときには使用できません。Important: The $ and _ characters cannot be used when specifying this property.
otherMailsotherMails StringString ユーザーの追加のメール アドレスの一覧 (例: ["bob@contoso.com", "Robert@fabrikam.com"])。A list of additional email addresses for the user; for example: ["bob@contoso.com", "Robert@fabrikam.com"].
passwordPoliciespasswordPolicies StringString ユーザーのパスワード ポリシーを指定します。Specifies password policies for the user. この値は列挙値であり、可能な 1 つの値は DisableStrongPassword です。この場合は、既定のポリシーより弱いパスワードを指定できます。This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration を指定することもできます。DisablePasswordExpiration can also be specified. 2 つを一緒に指定できます。例: DisablePasswordExpiration, DisableStrongPasswordThe two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.
passwordProfilepasswordProfile PasswordProfilePasswordProfile ユーザーのパスワード プロファイルを指定します。Specifies the password profile for the user. プロファイルには、ユーザーのパスワードが含まれています。The profile contains the user’s password. このプロパティは、ユーザーの作成時に必要です。This property is required when a user is created. プロファイルにあるパスワードは、passwordPolicies プロパティによって指定されている最小要件を満たす必要があります。The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. 既定では、強力なパスワードが必要です。By default, a strong password is required. これは、フェデレーション ユーザーには使用できません。This cannot be used for federated users.
pastProjectspastProjects String collectionString collection ユーザーが過去のプロジェクトを列挙する一覧。A list for the user to enumerate their past projects.
postalCodepostalCode StringString ユーザーの住所の郵便番号。郵便番号は、ユーザーの国/地域に固有です。アメリカ合衆国では、この属性には、ZIP コードが含まれます。The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.
preferredLanguagepreferredLanguage StringString ユーザーが設定する言語。The preferred language for the user. ISO 639-1 コードに従う必要があります。たとえば en-US です。Should follow ISO 639-1 Code; for example en-US.
responsibilitiesresponsibilities String collectionString collection ユーザーが自分の責任の範囲を列挙する一覧。A list for the user to enumerate their responsibilities.
schoolsschools String collectionString collection ユーザーが在籍した学校を列挙する一覧。A list for the user to enumerate the schools they have attended.
skillsskills String collectionString collection ユーザーが自分のスキルを列挙する一覧。A list for the user to enumerate their skills.
statestate StringString ユーザーの住所の都道府県。The state or province in the user's address.
streetAddressstreetAddress StringString ユーザーの勤務先の番地。The street address of the user's place of business.
surnamesurname StringString ユーザーの姓。The user's surname (family name or last name).
usageLocationusageLocation StringString 2 文字の国コード (ISO 規格 3166)A two letter country code (ISO standard 3166). 国におけるサービスの利用可能性を確認することが法的に義務付けられているため、ライセンスを割り当てられるユーザーには必須です。Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. たとえば、USJPGB などがあります。Examples include: US, JP, and GB. null 許容ではありません。Not nullable.
userPrincipalNameuserPrincipalName StringString ユーザーのユーザー プリンシパル名 (UPN)。The user principal name (UPN) of the user. UPN は、インターネット標準 RFC 822 に基づいた、インターネット スタイルのユーザーのログイン名です。The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. 規則では、これはユーザーの電子メール名にマップされる必要があります。By convention, this should map to the user's email name. 一般的な形式は alias@domain です。このドメインは、検証済みドメインのテナントのコレクション内に存在している必要があります。The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. このプロパティは、ユーザーの作成時に必要です。This property is required when a user is created. テナントの検証済みドメインには、organizationverifiedDomains プロパティからアクセスできます。The verified domains for the tenant can be accessed from the verifiedDomains property of organization. $filter$orderby をサポートします。Supports $filter and $orderby.
userTypeuserType StringString ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (MemberGuest など)。A string value that can be used to classify user types in your directory, such as Member and Guest.

注意

[フォロー中のプロパティ] は、アプリケーションのみのコンテキストを使用して更新することはできません:aboutMe誕生日採用日趣味個人pastProjectspreferredName役割学校スキルThe follow properties cannot be updated using an application-only context: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, and skills.

応答Response

成功した場合、このメソッドは 204 No Content 応答コードを返します。If successful, this method returns a 204 No Content response code.

Example

例 1: サインインしているユーザーのプロパティを更新するExample 1: Update properties of the signed-in user

要求Request

次の例は要求を示しています。The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/me
Content-type: application/json

{
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "officeLocation": "18/2111"
}

応答Response

次の例は応答を示しています。The following example shows the response.

HTTP/1.1 204 No Content

例 2: 指定したユーザーのプロパティを更新するExample 2: Update properties of the specified user

要求Request

次の例は要求を示しています。The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/users/{id}
Content-type: application/json

{
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "officeLocation": "18/2111"
}

応答Response

次の例は応答を示しています。The following example shows the response.

HTTP/1.1 204 No Content