Show / Hide Table of Contents

User.ReadWrite

Allows the app to read your profile. It also allows the app to update your profile information on your behalf.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 D DELETE /me/profile
V1 D DELETE /me/profile/account/{id}
V1 D DELETE /me/profile/addresses/{id}
V1 D DELETE /me/profile/anniversaries/{id}
V1 D DELETE /me/profile/awards/{id}
V1 D DELETE /me/profile/certifications/{id}
V1 D DELETE /me/profile/educationalActivities/{id}
V1 D DELETE /me/profile/emails/{id}
V1 D DELETE /me/profile/interests/{id}
V1 D DELETE /me/profile/languages/{id}
V1 D DELETE /me/profile/names/{id}
V1 D DELETE /me/profile/notes/{id}
V1 D DELETE /me/profile/patents/{id}
V1 D DELETE /me/profile/phones/{itemPhoneId}
V1 D DELETE /me/profile/positions/{id}
V1 D DELETE /me/profile/projects/{id}
V1 D DELETE /me/profile/publications/{id}
V1 D DELETE /me/profile/skills/{id}
V1 D DELETE /me/profile/webAccounts/{id}
V1 D DELETE /me/profile/websites/{id}
V1 D DELETE /me/responsibilities/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile
V1 D DELETE /users/{id | userPrincipalName}/profile/account/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/addresses/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/anniversaries/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/awards/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/certifications/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/emails/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/interests/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/languages/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/names/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/notes/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/patents/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/positions/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/projects/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/publications/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/skills/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/webAccounts/{id}
V1 D DELETE /users/{id | userPrincipalName}/profile/websites/{id}
V1 D DELETE /users/{id | userPrincipalName}/responsibilities/{id}
V1 D DELETE /users/{userId}/profile/phones/{itemPhoneId}
V1 D DELETE https://graph.microsoft.com/beta/organization/{organizationId}/settings/profileCardProperties/{directoryPropertyName-Value}
V1 D GET /groups/{id}/photo/$value
V1 D GET /me
V1 D GET /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D GET /me/contacts/{id}/photo/$value
V1 D GET /me/createdObjects
V1 D GET /me/photo/$value
V1 D GET /me/profile
V1 D GET /me/profile/account
V1 D GET /me/profile/account/{id}
V1 D GET /me/profile/addresses
V1 D GET /me/profile/addresses/{id}
V1 D GET /me/profile/anniversaries
V1 D GET /me/profile/anniversaries/{id}
V1 D GET /me/profile/awards
V1 D GET /me/profile/awards/{id}
V1 D GET /me/profile/certifications
V1 D GET /me/profile/certifications/{id}
V1 D GET /me/profile/educationalActivities
V1 D GET /me/profile/educationalActivities/{id}
V1 D GET /me/profile/emails
V1 D GET /me/profile/emails/{id}
V1 D GET /me/profile/interests
V1 D GET /me/profile/interests/{id}
V1 D GET /me/profile/languages
V1 D GET /me/profile/languages/{id}
V1 D GET /me/profile/names
V1 D GET /me/profile/names/{id}
V1 D GET /me/profile/notes
V1 D GET /me/profile/notes/{id}
V1 D GET /me/profile/patents
V1 D GET /me/profile/patents/{id}
V1 D GET /me/profile/phones
V1 D GET /me/profile/phones/{id}
V1 D GET /me/profile/positions
V1 D GET /me/profile/positions/{id}
V1 D GET /me/profile/projects
V1 D GET /me/profile/projects/{id}
V1 D GET /me/profile/publications
V1 D GET /me/profile/publications/{id}
V1 D GET /me/profile/skills
V1 D GET /me/profile/skills/{id}
V1 D GET /me/profile/webAccounts
V1 D GET /me/profile/webAccounts/{id}
V1 D GET /me/profile/websites
V1 D GET /me/profile/websites/{id}
V1 D GET /me/responsibilities
V1 D GET /me/responsibilities/{id}
V1 D GET /me/settings/contactMergeSuggestions
V1 D GET /me/settings/itemInsights
V1 D GET /team/{id}/photo/$value
V1 D GET /users/{id | userPrincipalName}
V1 D GET /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D GET /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 D GET /users/{id | userPrincipalName}/createdObjects
V1 D GET /users/{id | userPrincipalName}/photo/$value
V1 D GET /users/{id | userPrincipalName}/profile
V1 D GET /users/{id | userPrincipalName}/profile/account
V1 D GET /users/{id | userPrincipalName}/profile/account/{id}
V1 D GET /users/{id | userPrincipalName}/profile/addresses
V1 D GET /users/{id | userPrincipalName}/profile/addresses/{id}
V1 D GET /users/{id | userPrincipalName}/profile/anniversaries
V1 D GET /users/{id | userPrincipalName}/profile/anniversaries/{id}
V1 D GET /users/{id | userPrincipalName}/profile/awards
V1 D GET /users/{id | userPrincipalName}/profile/awards/{id}
V1 D GET /users/{id | userPrincipalName}/profile/certifications
V1 D GET /users/{id | userPrincipalName}/profile/certifications/{id}
V1 D GET /users/{id | userPrincipalName}/profile/educationalActivities
V1 D GET /users/{id | userPrincipalName}/profile/educationalActivities/{id}
V1 D GET /users/{id | userPrincipalName}/profile/emails
V1 D GET /users/{id | userPrincipalName}/profile/emails/{id}
V1 D GET /users/{id | userPrincipalName}/profile/interests
V1 D GET /users/{id | userPrincipalName}/profile/interests/{id}
V1 D GET /users/{id | userPrincipalName}/profile/languages
V1 D GET /users/{id | userPrincipalName}/profile/languages/{id}
V1 D GET /users/{id | userPrincipalName}/profile/names
V1 D GET /users/{id | userPrincipalName}/profile/names/{id}
V1 D GET /users/{id | userPrincipalName}/profile/notes
V1 D GET /users/{id | userPrincipalName}/profile/notes/{id}
V1 D GET /users/{id | userPrincipalName}/profile/patents
V1 D GET /users/{id | userPrincipalName}/profile/patents/{id}
V1 D GET /users/{id | userPrincipalName}/profile/phones
V1 D GET /users/{id | userPrincipalName}/profile/positions
V1 D GET /users/{id | userPrincipalName}/profile/positions/{id}
V1 D GET /users/{id | userPrincipalName}/profile/projects
V1 D GET /users/{id | userPrincipalName}/profile/projects/{id}
V1 D GET /users/{id | userPrincipalName}/profile/publications
V1 D GET /users/{id | userPrincipalName}/profile/publications/{id}
V1 D GET /users/{id | userPrincipalName}/profile/skills
V1 D GET /users/{id | userPrincipalName}/profile/skills/{id}
V1 D GET /users/{id | userPrincipalName}/profile/webAccounts
V1 D GET /users/{id | userPrincipalName}/profile/webAccounts/{id}
V1 D GET /users/{id | userPrincipalName}/profile/websites
V1 D GET /users/{id | userPrincipalName}/profile/websites/{id}
V1 D GET /users/{id | userPrincipalName}/responsibilities
V1 D GET /users/{id | userPrincipalName}/responsibilities/{id}
V1 D GET /users/{userId}/profile/phones/{id}
V1 D GET /users/{userId}/settings/itemInsights
V1 D GET /users/{userId}/usageRights
V1 D GET /users/delta
V1 D PATCH /groups/{id}/photo/$value
V1 D PATCH /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D PATCH /me/contacts/{id}/photo/$value
V1 D PATCH /me/photo/$value
V1 D PATCH /me/profile/account/{id}
V1 D PATCH /me/profile/addresses/{id}
V1 D PATCH /me/profile/anniversaries/{id}
V1 D PATCH /me/profile/awards/{id}
V1 D PATCH /me/profile/certifications/{id}
V1 D PATCH /me/profile/educationalActivities/{id}
V1 D PATCH /me/profile/emails/{id}
V1 D PATCH /me/profile/interests/{id}
V1 D PATCH /me/profile/languages/{id}
V1 D PATCH /me/profile/names/{id}
V1 D PATCH /me/profile/notes/{id}
V1 D PATCH /me/profile/patents/{id}
V1 D PATCH /me/profile/phones/{id}
V1 D PATCH /me/profile/positions/{id}
V1 D PATCH /me/profile/projects/{id}
V1 D PATCH /me/profile/publications/{id}
V1 D PATCH /me/profile/skills/{id}
V1 D PATCH /me/profile/webAccounts/{id}
V1 D PATCH /me/profile/websites/{id}
V1 D PATCH /me/responsibilities/{id}
V1 D PATCH /me/settings
V1 D PATCH /me/settings/contactMergeSuggestions
V1 D PATCH /me/settings/itemInsights
V1 D PATCH /users/{id | userPrincipalName}
V1 D PATCH /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D PATCH /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 D PATCH /users/{id | userPrincipalName}/photo/$value
V1 D PATCH /users/{id | userPrincipalName}/profile/account/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/addresses/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/anniversaries/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/awards/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/certifications/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/emails/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/interests/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/languages/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/names/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/notes/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/patents/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/positions/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/projects/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/publications/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/skills/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/webAccounts/{id}
V1 D PATCH /users/{id | userPrincipalName}/profile/websites/{id}
V1 D PATCH /users/{id | userPrincipalName}/responsibilities/{id}
V1 D PATCH /users/{userId}/profile/phones/{id}
V1 D PATCH /users/{userId}/settings/itemInsights
V1 D PATCH https://graph.microsoft.com/beta/organization/{organizationId}/settings/profileCardProperties/{id}
V1 D POST /me/invalidateAllRefreshTokens
V1 D POST /me/profile/account
V1 D POST /me/profile/addresses
V1 D POST /me/profile/anniversaries
V1 D POST /me/profile/awards
V1 D POST /me/profile/certifications
V1 D POST /me/profile/educationalActivities
V1 D POST /me/profile/emails
V1 D POST /me/profile/interests
V1 D POST /me/profile/languages
V1 D POST /me/profile/names
V1 D POST /me/profile/notes
V1 D POST /me/profile/patents
V1 D POST /me/profile/phones
V1 D POST /me/profile/positions
V1 D POST /me/profile/projects
V1 D POST /me/profile/publications
V1 D POST /me/profile/skills
V1 D POST /me/profile/webAccounts
V1 D POST /me/profile/websites
V1 D POST /me/responsibilities
V1 D POST /me/translateExchangeIds
V1 D POST /users/{id | userPrincipalName}/invalidateAllRefreshTokens
V1 D POST /users/{id | userPrincipalName}/profile/account
V1 D POST /users/{id | userPrincipalName}/profile/addresses
V1 D POST /users/{id | userPrincipalName}/profile/anniversaries
V1 D POST /users/{id | userPrincipalName}/profile/awards
V1 D POST /users/{id | userPrincipalName}/profile/certifications
V1 D POST /users/{id | userPrincipalName}/profile/educationalActivities
V1 D POST /users/{id | userPrincipalName}/profile/emails
V1 D POST /users/{id | userPrincipalName}/profile/interests
V1 D POST /users/{id | userPrincipalName}/profile/languages
V1 D POST /users/{id | userPrincipalName}/profile/names
V1 D POST /users/{id | userPrincipalName}/profile/notes
V1 D POST /users/{id | userPrincipalName}/profile/patents
V1 D POST /users/{id | userPrincipalName}/profile/positions
V1 D POST /users/{id | userPrincipalName}/profile/projects
V1 D POST /users/{id | userPrincipalName}/profile/publications
V1 D POST /users/{id | userPrincipalName}/profile/skills
V1 D POST /users/{id | userPrincipalName}/profile/webAccounts
V1 D POST /users/{id | userPrincipalName}/profile/websites
V1 D POST /users/{id | userPrincipalName}/responsibilities
V1 D POST /users/{id|userPrincipalName}/translateExchangeIds
V1 D POST /users/{userId}/profile/phones
V1 D POST /users/validatePassword
V1 D POST https://graph.microsoft.com/beta/organization/{organizationId}/settings/profileCardProperties
V1 D PUT /groups/{id}/photo/$value
V1 D PUT /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D PUT /me/contacts/{id}/photo/$value
V1 D PUT /me/photo/$value
V1 A,D PUT /settings/regionalAndLanguageSettings
V1 D PUT /team/{id}/photo/$value
V1 D PUT /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 D PUT /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 D PUT /users/{id | userPrincipalName}/photo/$value

Delegate Permission

Id b4e74841-8e56-480b-be8b-910348b18b4c
Consent Type User
Display String Read and write access to user profile
Description Allows the app to read your profile. It also allows the app to update your profile information on your behalf.

Application Permission

Id
Display String
Description

Resources

assignedLicense

Property Type Description
disabledPlans Guid collection A collection of the unique identifiers for plans that have been disabled.
skuId Guid The unique identifier for the SKU.

companyDetail

Property Type Description
address physicalAddress Address of the company.
department String Department Name within a company.
displayName String Company name.
officeLocation String Office Location of the person referred to.
pronunciation String Pronunciation guide for the company name.
webUrl String Link to the company home page.

contactMergeSuggestions

Property Type Description
isEnabled Boolean true if the duplicate contact merge suggestions feature is enabled for the user; false if the feature is disabled. Default value is true.

convertIdResult

Property Type Description
errorDetails genericError An error object indicating the reason for the conversion failure. This value is not present if the conversion succeeded.
sourceId String The identifier that was converted. This value is the original, un-converted identifier.
targetId String The converted identifier. This value is not present if the conversion failed.

customSecurityAttributeValue

directoryObject

Property Type Description
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted.
id String The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the **i

educationalActivity

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.
completionMonthYear Date The month and year the user graduated or completed the activity.
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.
endMonthYear Date The month and year the user completed the educational activity referenced.
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.
institution institutionData Contains details of the institution studied at.
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.
program educationalActivityDetail Contains extended information about the program or course.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
startMonthYear Date The month and year the user commenced the activity referenced.

educationalActivityDetail

Property Type Description
abbreviation String Shortened name of the degree or program (example: PhD, MBA)
activities String Extracurricular activities undertaken alongside the program.
awards String Any awards or honors associated with the program.
description String Short description of the program provided by the user.
displayName String Long-form name of the program that the user has provided.
fieldsOfStudy String Majors and minors associated with the program. (if applicable)
grade String The final grade, class, GPA or score.
notes String Additional notes the user has provided.
webUrl String Link to the degree or program page.

entity

Property Type Description
id String The unique idenfier for an entity. Read-only.

GeoCoordinates

Property Type Description
altitude Double Optional. The altitude (height), in feet, above sea level for the item. Read-only.
latitude Double Optional. The latitude, in decimal, for the item. Read-only.
longitude Double Optional. The longitude, in decimal, for the item. Read-only.

identitySet

Property Type Description
application identity Optional. The application associated with this action.
device identity Optional. The device associated with this action.
user identity Optional. The user associated with this action.

inferenceData

Property Type Description
confidenceScore Double Confidence score reflecting the accuracy of the data inferred about the user.
userHasVerifiedAccuracy Boolean Records if the user has confirmed this inference as being True or False.

institutionData

Property Type Description
description String Short description of the institution the user studied at.
displayName String Name of the institution the user studied at.
location physicalAddress Address or location of the institute.
webUrl String Link to the institution or department homepage.

itemAddress

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.
detail physicalAddress Details about the address itself.
displayName String Friendly name the user has assigned to this address.
geoCoordinates geoCoordinates The geocoordinates of the address.
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.
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.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.

itemBody

Property Type Description
content String The content of the item.
contentType bodyType The type of the content. Possible values are text and html.

itemEmail

Property Type Description
address String The email address itself.
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 The name or label a user has associated with a particular email address.
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.
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.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
type emailType The type of email address. Possible values are: unknown, work, personal, main, other.

itemFacet

Property Type Description
allowedAudiences allowedAudiences The audiences that are able to see the values contained within the associated entity. 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.
createdDateTime DateTimeOffset Provides the dateTimeOffset for when the entity was created.
id String Identifier used for individually addressing an entity. Inherited from entity
inference inferenceData Contains inference detail if the entity is inferred by the creating or modifying application.
lastModifiedBy identitySet Provides the identifier of the user and/or application that last modified the entity.
lastModifiedDateTime DateTimeOffset Provides the dateTimeOffset for when the entity was created.
source personDataSource Where the values within an entity originated if synced from another service.

itemInsights

itemPatent

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.
description String Descpription of the patent or filing.
displayName String Title of the patent or filing.
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.
isPending Boolean Indicates the patent is pending.
issuedDate Date The date that the patent was granted.
issuingAuthority String Authority which granted the patent.
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.
number String The patent number.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
webUrl String URL referencing the patent or filing.

itemPhone

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 Friendly name the user has assigned this phone number.
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.
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.
number String Phone number provided by the user.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
type phoneType The type of phone number within the object. Possible values are: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio.

itemPublication

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.
description String Description of the publication.
displayName String Title of the publication.
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.
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.
publishedDate Date The date that the publication was published.
publisher String Publication or publisher for the publication.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
thumbnailUrl String URL referencing a thumbnail of the publication.
webUrl String URL referencing the publication.

languageProficiency

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 Contains the long-form name for the language.
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.
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.
reading languageProficiencyLevel Represents the users reading comprehension for the language represented by the object. Possible values are: elementary, conversational, limitedWorking, professionalWorking, fullProfessional, nativeOrBilingual, unknownFutureValue.
source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
spoken languageProficiencyLevel Represents the users spoken proficiency for the language represented by the object. Possible values are: elementary, conversational, limitedWorking, professionalWorking, fullProfessional, nativeOrBilingual, unknownFutureValue.
tag String Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU).
written languageProficiencyLevel Represents the users written proficiency for the language represented by the object. Possible values are: elementary, conversational, limitedWorking, professionalWorking, fullProfessional, nativeOrBilingual, unknownFutureValue.

localeInfo

Property Type Description
displayName string A name representing the user's locale in natural language, for example, "English (United States)".
locale string A locale representation for the user, which includes the user's preferred language and country/region. For example, "en-us". The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.

objectIdentity

Property Type Description
issuer string Specifies the issuer of the identity, for example facebook.com.
For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.
For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.

Supports $filter. 512 character limit.
issuerAssignedId string Specifies the unique identifier assigned to the user by the issuer. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).
When signInType is set to:
  • emailAddress, (or a custom string that starts with emailAddress like emailAddress1) issuerAssignedId must be a valid email address
  • userName, issuerAssignedId must begin with alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _
Supports $filter. 64 character limit.
signInType String Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity will update the value of the **u

onPremisesExtensionAttributes

Property Type Description
extensionAttribute1 String First customizable extension attribute.
extensionAttribute2 String Second customizable extension attribute.
extensionAttribute3 String Third customizable extension attribute.
extensionAttribute4 String Fourth customizable extension attribute.
extensionAttribute5 String Fifth customizable extension attribute.
extensionAttribute6 String Sixth customizable extension attribute.
extensionAttribute7 String Seventh customizable extension attribute.
extensionAttribute8 String Eighth customizable extension attribute.
extensionAttribute9 String Ninth customizable extension attribute.
extensionAttribute10 String Tenth customizable extension attribute.
extensionAttribute11 String Eleventh customizable extension attribute.
extensionAttribute12 String Twelfth customizable extension attribute.
extensionAttribute13 String Thirteenth customizable extension attribute.
extensionAttribute14 String Fourteenth customizable extension attribute.
extensionAttribute15 String Fifteenth customizable extension attribute.

organization

Property Type Description
assignedPlans assignedPlan collection The collection of service plans associated with the tenant. Not nullable.
businessPhones String collection Telephone number for the organization. Although this is a string collection, only one number can be set for this property.
city String City name of the address for the organization.
country String Country/region name of the address for the organization.
countryLetterCode String Country or region abbreviation for the organization in ISO 3166-2 format.
createdDateTime DateTimeOffset Timestamp of when the organization was created. The value cannot be modified and is automatically populated when the organization is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
defaultUsageLocation String Two-letter ISO 3166 country code indicating the default service usage location of an organization.
deletedDateTime DateTimeOffset Represents date and time of when the Azure AD tenant was deleted using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
displayName String The display name for the tenant.
id String The tenant ID, a unique identifier representing the organization (or tenant). Inherited from directoryObject. Key. Not nullable. Read-only.
isMultipleDataLocationsForServicesEnabled Boolean true if organization is Multi-Geo enabled; false if organization is not Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo.
marketingNotificationEmails String collection Not nullable.
onPremisesLastSyncDateTime DateTimeOffset The time and date at which the tenant was last synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced. Nullable. null if this object has never been synced from an on-premises directory (default).
postalCode String Postal code of the address for the organization.
preferredLanguage String The preferred language for the organization. Should follow ISO 639-1 Code; for example, en.
privacyProfile privacyProfile The privacy profile of an organization.
provisionedPlans ProvisionedPlan collection Not nullable.
securityComplianceNotificationMails String collection
securityComplianceNotificationPhones String collection
state String State name of the address for the organization.
street String Street name of the address for organization.
technicalNotificationMails String collection Not nullable.
tenantType String Not nullable. The tenant type option that was selected when the tenant was created. The possible values are:
  • AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios.
  • AAD B2C A customer identity access management (CIAM) service that serves business-to-consumer (B2C) scenarios.
  • verifiedDomains VerifiedDomain collection The collection of domains associated with this tenant. Not nullable.

    passwordProfile

    Property Type Description
    forceChangePasswordNextSignIn Boolean true if the user must change her password on the next login; otherwise false.
    forceChangePasswordNextSignInWithMfa Boolean If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.
    password String The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next login. The password must satisfy minimum requirements as specified by the user’s **p

    passwordValidationInformation

    Property Type Description
    isValid Boolean Specifies whether the password is valid based on the calculation of the results in the validationResults property. Not nullable. Read-only.
    validationResults validationResult collection The list of password validation rules and whether the password passed those rules. Not nullable. Read-only.

    personAnniversary

    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.
    date Date Contains the date associated with the anniversary type.
    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.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    type anniversaryType The type of anniversary the date represents. Possible values are: birthday, wedding, unknownFutureValue.

    personAnnotation

    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.
    detail itemBody Contains the detail of the note itself.
    displayName String Contains a friendly name for the note.
    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.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.

    personAward

    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.
    description String Descpription of the award or honor.
    displayName String Name of the award or honor.
    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.
    issuedDate Date The date that the award or honor was granted.
    issuingAuthority String Authority which granted the award or honor.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    thumbnailUrl String URL referencing a thumbnail of the award or honor.
    webUrl String URL referencing the award or honor.

    personCertification

    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.
    certificationId String The referenceable identifier for the certification.
    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.
    description String Description of the certification.
    displayName String Title of the certification.
    endDate Date The date that the certification expires.
    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.
    issuedDate Date The date that the certification was issued.
    issuingAuthority String Authority which granted the certification.
    issuingCompany String Company which granted the certification.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    startDate Date The date that the certification became valid.
    thumbnailUrl String URL referencing a thumbnail of the certification.
    webUrl String URL referencing the certification.

    personDataSource

    Property Type Description
    type String The type of data source.

    personInterest

    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.
    categories String collection Contains categories a user has associated with the interest (for example, personal, recipies).
    collaborationTags String collection Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.
    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.
    description String Contains a description of the interest.
    displayName String Contains a friendly name for the interest.
    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.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    webUrl String Contains a link to a web page or resource about the interest.

    personName

    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.)

    personResponsibility

    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.
    collaborationTags String collection Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.
    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.
    description String Description of the responsibility.
    displayName String Contains a friendly name for the responsibility.
    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.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    webUrl String Contains a link to a web page or resource about the responsibility.

    personWebsite

    Property Type Description
    categories String collection Contains categories a user has associated with the website (for example, personal, recipes).
    description String Contains a description of the website.
    displayName String Contains a friendly name for the website.
    webUrl String Contains a link to the website itself.

    physicalAddress

    Property Type Description
    city String The city.
    countryOrRegion String The country or region. It's a free-format string value, for example, "United States".
    postalCode String The postal code.
    state String The state.
    street String The street.

    positionDetail

    Property Type Description
    company companyDetail Detail about the company or employer.
    description String Description of the position in question.
    endMonthYear Date When the position ended.
    jobTitle String The title held when in that position.
    role String The role the position entailed.
    startMonthYear Date The start month and year of the position.
    summary String Short summary of the position.

    profile

    Property Type Description
    id String Read-only.

    profileCardProperty

    Property Type Description
    annotations profileCardAnnotation collection Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant.
    directoryPropertyName String Identifies a **p

    profilePhoto

    Property Type Description
    id string Read-only.
    height int32 The height of the photo. Read-only.
    width int32 The width of the photo. Read-only.

    projectParticipation

    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.
    categories String collection Contains categories a user has associated with the project (for example, digital transformation, oil rig).
    client companyDetail Contains detailed information about the client the project was for.
    collaborationTags String collection Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.
    colleagues relatedPerson collection Lists people that also worked on the project.
    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.
    detail positionDetail Contains detail about the user's role on the project.
    displayName String Contains a friendly name for the project.
    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.
    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.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    sponsors relatedPerson collection The Person or people who sponsored the project.

    relatedPerson

    Property Type Description
    displayName String Name of the person.
    relationship String Possible values are: manager, colleague, directReport, dotLineReport, assistant, dotLineManager, alternateContact, friend, spouse, sibling, child, parent, sponsor, emergencyContact, other, unknownFutureValue.
    userPrincipalName String Email address or reference to person within organization.

    serviceInformation

    Property Type Description
    name String The name of the cloud service (for example, Twitter, Instagram).
    webUrl String Contains the URL for the service being referenced.

    skillProficiency

    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.
    categories String collection Contains categories a user has associated with the skill (for example, personal, professional, hobby).
    collaborationTags String collection Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.
    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 Contains a friendly name for the skill.
    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.
    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.
    proficiency skillProficiencyLevel Detail of the users proficiency with this skill. Possible values are: elementary, limitedWorking, generalProfessional, advancedProfessional, expert, unknownFutureValue.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    webUrl String Contains a link to an information source about the skill.

    usageRight

    Property Type Description
    catalogId String Product id corresponding to the usage right.
    id String The id of the usage right.
    serviceIdentifier String Identifier of the service corresponding to the usage right.
    state usageRightState The state of the usage right. Possible values are: active, inactive, warning, suspended.

    user

    Property Type Description
    aboutMe String A freeform text entry field for the user to describe themselves. Returned only on $select.
    accountEnabled Boolean true if the account is enabled; otherwise, false. This property is required when a user is created.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    ageGroup ageGroup Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    assignedLicenses assignedLicense collection The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
    assignedPlans assignedPlan collection The plans that are assigned to the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq and not).
    birthday DateTimeOffset The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    businessPhones String collection The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory.

    Returned by default. Supports $filter (eq, not, ge, le, startsWith).
    city String The city in which the user is located. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    companyName String The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    consentProvidedForMinor consentProvidedForMinor Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    country String The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    createdDateTime DateTimeOffset The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    creationType String Indicates whether the user account was created through one of the following methods:
    • As a regular school or work account (null).
    • As an external account (Invitation).
    • As a local account for an Azure Active Directory B2C tenant (LocalAccount).
    • Through self-service sign-up by an internal user using email verification (EmailVerified).
    • Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).

    Read-only.
    Returned only on $select. Supports $filter (eq, ne, not, in).
    deletedDateTime DateTimeOffset The date and time the user was deleted.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    department String The name for the department in which the user works. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).
    displayName String 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. Maximum length is 256 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.
    employeeHireDate DateTimeOffset The date and time when the user was hired or will start work in case of a future hire.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeId String The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    employeeOrgData employeeOrgData Represents organization data (e.g. division and costCenter) associated with a user.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeType String Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
    externalUserState String For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.

    Returned only on $select. Supports $filter (eq, ne, not , in).
    externalUserStateChangeDateTime DateTimeOffset Shows the timestamp for the latest change to the externalUserState property.

    Returned only on $select. Supports $filter (eq, ne, not , in).
    faxNumber String The fax number of the user.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    givenName String The given name (first name) of the user. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    hireDate DateTimeOffset The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
    id String The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only.

    Returned by default. Supports $filter (eq, ne, not, in).
    identities objectIdentity collection Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value.

    Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.
    imAddresses String collection The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).
    interests String collection A list for the user to describe their interests.

    Returned only on $select.
    isResourceAccount Boolean Do not use – reserved for future use.
    jobTitle String The user's job title. Maximum length is 128 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    lastPasswordChangeDateTime DateTimeOffset The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    legalAgeGroupClassification legalAgeGroupClassification Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information.

    Returned only on $select.
    licenseAssignmentStates licenseAssignmentState collection State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only.

    Returned only on $select.
    mail String The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.
    NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).
    mailboxSettings mailboxSettings Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone.

    Returned only on $select.
    mailNickname String The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mobilePhone String The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mySite String The URL for the user's personal site.

    Returned only on $select.
    officeLocation String The office location in the user's place of business.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    onPremisesDistinguishedName String Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesDomainName String Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesExtensionAttributes onPremisesExtensionAttributes Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.
  • For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only.
  • For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object.
  • For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.

  • Returned only on $select. Supports $filter (eq, ne, not, in).
    onPremisesImmutableId String This property is used to associate an on-premises Active Directory user account to their Azure AD user object. 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. NOTE: The $ and _ characters cannot be used when specifying this property.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..
    onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    onPremisesSamAccountName String Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only.

    Returned only on $select. Supports $filter (eq including on null values).
    onPremisesSyncEnabled Boolean true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Azure Active Directory (Azure AD). Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    onPremisesUserPrincipalName String Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    otherMails String collection A list of additional email addresses for the user; for example: ["[email protected]", "[email protected]"].
    NOTE: This property cannot contain accent characters.

    Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
    passwordPolicies String Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

    Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).
    passwordProfile passwordProfile Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    pastProjects String collection A list for the user to enumerate their past projects.

    Returned only on $select.
    postalCode String 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. Maximum length is 40 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    preferredDataLocation String The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
    preferredLanguage String The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)
    preferredName String The preferred name for the user. Not Supported. This attribute returns an empty string.

    Returned only on $select.
    provisionedPlans provisionedPlan collection The plans that are provisioned for the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
    refreshTokensValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint.

    Returned only on $select. Read-only.
    responsibilities String collection A list for the user to enumerate their responsibilities.

    Returned only on $select.
    schools String collection A list for the user to enumerate the schools they have attended.

    Returned only on $select.
    securityIdentifier String Security identifier (SID) of the user, used in Windows scenarios.

    Read-only. Returned by default.
    Supports $select and $filter (eq, not, ge, le, startsWith).
    showInAddressList Boolean Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
    signInSessionsValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.

    Returned only on $select.
    skills String collection A list for the user to enumerate their skills.

    Returned only on $select.
    state String The state or province in the user's address. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    streetAddress String The street address of the user's place of business. Maximum length is 1024 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    surname String The user's surname (family name or last name). Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    usageLocation String 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. Examples include: US, JP, and GB. Not nullable.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    userPrincipalName String The user principal name (UPN) of the user. 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. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.
    NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.
    userType String A string value that can be used to classify user types in your directory, such as Member and Guest.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). **N

    userAccountInformation

    Property Type Description
    ageGroup String Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.
    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.
    countryCode String Contains the two-character country code associated with the users account.
    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.
    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.
    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.
    preferredLanguageTag localeInfo Contains the language the user has associated as preferred for the account.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    userPrincipalName String The user principal name (UPN) of the user associated with the account.

    userInsightsSettings

    Property Type Description
    isEnabled Boolean true if user's **i

    userSettings

    Property Type Description
    contributionToContentDiscoveryAsOrganizationDisabled Boolean Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn't have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for Business is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.
    contributionToContentDiscoveryDisabled Boolean When set to true, the delegate access to the user's trending API is disabled. When set to true, documents in the user's Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for Business is affected. Users can control this setting in Office Delve.
    id String Unique identifier of the user setting. Read-only. Inherited from entity.

    webAccount

    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.
    description String Contains the description the user has provided for the account on the service being referenced.
    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.
    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.
    service serviceInformation Contains basic detail about the service that is being associated.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.
    statusMessage String Contains a status message from the cloud service if provided or synchronized.
    userId String The user name displayed for the webaccount.
    webUrl String Contains a link to the user's profile on the cloud service if one exists.

    workPosition

    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.
    categories String collection Categories that the user has associated with this position.
    colleagues relatedPerson collection Colleagues that are associated with this position.
    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.
    detail positionDetail Contains detailed information about the position.
    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.
    isCurrent Boolean Denotes whether or not the position is current.
    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.
    manager relatedPerson Contains detail of the user's manager in this position.
    source personDataSource Where the values originated if synced from another service. Inherited from itemFacet.

    yomiPersonName

    Property Type Description
    displayName String Composite of first and last name pronunciation guides.
    first String Pronunciation guide for the first name of the user.
    last String Pronunciation guide for the last name of the user.
    maiden String Pronunciation guide for the maiden name of the user.
    middle String Pronunciation guide for the middle name of the user.
    In This Article
    Back to top Created by merill | Submit feedback