Edit

Share via


personName resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents extended name information provided by the user or which they have associated within their profile.

Inherits from itemFacet.

Methods

Method Return type Description
List personName collection Get the personName resources from the names navigation property.
Create personName Create a new personName object from the names navigation property.
Get personName Read the properties and relationships of a personName object.
Update personName Update the properties of a personName object.
Delete None Deletes a personName object.

Properties

Property Type Description
allowedAudiences String The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me, family, contacts, groupMembers, organization, federatedOrganizations, everyone, unknownFutureValue.
createdBy identitySet Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet.
createdDateTime DateTimeOffset Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet.
displayName String Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.
first String First name of the user.
id String Identifier used for individually addressing the entity. Inherited from entity
inference inferenceData Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet.
initials String Initials of the user.
languageTag String Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.
last String Last name of the user.
lastModifiedBy identitySet Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet.
lastModifiedDateTime DateTimeOffset Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet.
maiden String Maiden name of the user.
middle String Middle name of the user.
nickname String Nickname of the user.
pronunciation yomiPersonName Guidance on how to pronounce the users name.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
suffix String Designators used after the users name (eg: PhD.)
title String Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.personName",
  "id": "e13f7a4d-303c-464f-a6af-80ea18eb74f3",
  "allowedAudiences": "organization",
  "inference": {
    "@odata.type": "microsoft.graph.inferenceData"
  },
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "source": {
    "@odata.type": "microsoft.graph.personDataSource"
  },
  "displayName": "Innocenty Popov",
  "first": "Innocenty",
  "initials": "IP",
  "last": "Popov",
  "languageTag": "en-US",
  "maiden": null,
  "middle": null,
  "nickname": "Kesha",
  "suffix": null,
  "title": null,
  "pronunciation": {
    "@odata.type": "microsoft.graph.yomiPersonName"
  }
}