user 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 a Microsoft Entra user account. This resource is an open type that allows other properties to be passed in. Inherits from directoryObject.
The user resource lets apps specify user preferences for languages and date/time formats for the user's primary Exchange mailboxes and Microsoft Entra profile. For more information, see user preferences for languages and regional formats.
For performance reasons, the create, get, and list operations return only a subset of more commonly used properties by default. These default properties are noted in the Properties section. To get any of the properties not returned by default, specify them in a $select
OData query option.
This resource supports:
- Adding your data to custom properties as extensions.
- Subscribing to change notifications.
- Using delta query to track incremental additions, deletions, and updates, by providing a delta function.
Methods
Method | Return Type | Description |
---|---|---|
List users | user collection | Get a list of user objects. |
Create user | user | Create a new user object. |
Get user | user | Read properties and relationships of user object. |
Update user | user | Update user object. |
Delete user | None | Delete user object. |
Get delta | user collection | Get incremental changes for users. |
changePassword | None | Update your own password. |
Convert external user to internal member user | user | Convert an externally authenticated user into an internal member user. |
invalidateAllRefreshTokens | user | Invalidate all of the user's refresh tokens issued to applications. |
validatePassword | passwordValidationInformation | Validate a user's password against the organization's password validation policy and report whether the password is valid. |
App role assignments | ||
List appRoleAssignments | appRoleAssignment collection | Get the apps and app roles that a user has been assigned. |
List appRoleAssignedResources | servicePrincipal collection | Get the apps that a user has an app role assignment either directly or through group membership. |
Add appRoleAssignment | appRoleAssignment | Assign an app role to a user. |
Remove appRoleAssignment | None | Remove an app role assignment from a user. |
Calendar | ||
Create calendar | Calendar | Create a new Calendar by posting to the calendars collection. |
Create calendarGroup | CalendarGroup | Create a new CalendarGroup by posting to the calendarGroups collection. |
Create event | event | Create a new event by posting to the events collection. |
findMeetingTimes | meetingTimeSuggestionsResult | Find time and locations to meet based on attendee availability, location, or time constraints. |
findRooms | emailaddress.md collection | Get all the meeting rooms in the user's tenant or a specific room list. |
findRoomLists | emailaddress.md collection | Get the room lists defined in a tenant. |
getSchedule | scheduleInformation | Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified period. |
List calendars | Calendar collection | Get a Calendar object collection. |
List calendarGroups | CalendarGroup collection | Get a CalendarGroup object collection. |
List calendarView | event collection | Get an event object collection. |
List events | event collection | Get a list of event objects in the user's mailbox. The list contains single instance meetings and series masters. |
reminderView | Reminder collection | Return a list of calendar reminders within the start and end times specified. |
Contacts | ||
Create contact | contact | Create a new contact by posting to the contacts collection. |
Create contactFolder | contactFolder | Create a new contactFolder by posting to the contactFolders collection. |
List contacts | contact collection | Get a contact collection from the default contacts folder of the signed-in user. |
List contactFolders | contactFolder collection | Get the contact folder collection in the default contacts folder of the signed-in user. |
Directory objects | ||
assignLicense | user | Add or remove subscriptions for the user. You can also enable and disable specific plans associated with a subscription. |
exportPersonalData | None | Submits a data policy operation request made by a company administrator to export an organizational user's data. |
getByIds | String collection | Returns the directory objects specified in a list of IDs. |
checkMemberGroups | String collection | Check for membership in a list of groups. The check is transitive. |
checkMemberObjects | String collection | Check for membership in a list of group, directory role, or administrative unit objects. The check is transitive. |
getMemberGroups | String collection | Return all the groups the user is a member of. The check is transitive. |
getMemberObjects | String collection | Return all the groups, directory roles, and administrative units the user is a member of. The check is transitive. |
Get transitiveReports | Integer | Get the count of transitive reports for a user from the transitiveReports navigation property. |
List createdObjects | directoryObject collection | Get the directory objects created by the user from the createdObjects navigation property. |
List licenseDetails | licenseDetails collection | Get a licenseDetails object collection. |
List ownedDevices | directoryObject collection | Get the devices that the user owns from the ownedDevices navigation property. |
List ownedObjects | directoryObject collection | Get the directory objects owned by the user from the ownedObjects navigation property. |
List registeredDevices | directoryObject collection | Get the devices that are registered for the user from the registeredDevices navigation property. |
List scoped-role memberships | scopedRoleMembership collection | Get the scoped-role administrative units memberships for this user. |
List usageRights | usageRight collection | Get a collection of usage rights granted to the user. |
reprocessLicense | user | Reprocess subscription assignments for the user. |
revokeSignInSessions | None | Revokes all the user's refresh and session tokens issued to applications by resetting the signInSessionsValidFromDateTime user property to the current date-time. This operation forces the user to sign in to those applications again. This method replaces invalidateAllRefreshTokens. |
List deleted users | directoryObject collection | Retrieve the users deleted in the tenant in the last 30 days. |
Get deleted user | directoryObject collection | Retrieve a deleted user by ID. |
Restore deleted user | directoryObject collection | Restore a user deleted in the tenant in the last 30 days. |
Permanently delete user | directoryObject collection | Permanently delete a deleted user from the tenant. |
Drive | ||
Get drive | drive | Retrieve the properties and relationships of a Drive resource. |
List children | DriveItems | Return a collection of DriveItems in the children relationship of a DriveItem. |
Groups | ||
List joinedTeams | team collection | Get the Microsoft Teams teams that the user is a direct member of from the joinedTeams navigation property. |
List memberOf | directoryObject collection | Get the groups, directory roles, and administrative units that the user is a direct member of. This operation is not transitive. |
List transitiveMemberOf | directoryObject collection | Get the groups, directory roles, and administrative units that the user is a member of through either direct or transitive membership. |
Insights | ||
List shared | sharedInsight collection | Calculated insight that returns the list of files shared with a user. |
List trending | trending collection | Calculated insight that returns the list of items trending around the user. |
List used | usedInsight collection | Calculated insight that returns the list of files used with a user. |
Create inferenceClassificationOverride | inferenceClassificationOverride | Create a Focused Inbox override for a sender identified by an SMTP address. |
Create mailFolder | mailFolder | Create a new mailFolder by posting to the mailFolders collection |
Create message | message | Create a message by posting to the messages collection. |
Create messageRule | messageRule | Create a messageRule object by specifying a set of conditions and actions. |
getMailTips | mailTips collection | Return the MailTips of one or more recipients as available to the signed-in user. |
List mailFolders | mailFolder collection | Get the mail folder collection under the root folder of the signed-in user. |
List messages | message collection | Get all the messages in the signed-in user's mailbox. |
List overrides | inferenceClassificationOverride collection | Get the focused inbox overrides that a user sets up to classify messages from certain senders in specific ways. |
List rules | messageRule collection | Get all the messageRule objects defined for the user's inbox. |
Send mail | None | Send the message specified in the request body. |
Notes | ||
Create notebook | notebook | Create a new OneNote notebook. |
List notebooks | notebook collection | Retrieve a list of notebook objects. |
Open extensions | ||
Create open extension | openTypeExtension | Create an open extension and add custom properties to a new or existing resource. |
Get open extension | openTypeExtension collection | Get an open extension identified by the extension name. |
Org hierarchy | ||
Assign manager | None | Assign a user's manager. |
Get manager | directoryObject | Get the user or contact that is this user's manager from the manager navigation property. |
Remove manager | None | Remove the manager of a user. |
List directReports | directoryObject collection | Get the users and contacts that report to the user from the directReports navigation property. |
Outlook settings | ||
Create Outlook category | outlookCategory | Create an outlookCategory object in the user's master list of categories. |
Get supportedLanguages | localeInfo collection | Get the list of locales and languages that are supported for the user, as configured on the user's mailbox server. |
Get supportedTimeZones | timeZoneInformation collection | Get the list of time zones that are supported for the user, as configured on the user's mailbox server. |
Get user mailbox settings | mailboxSettings | Get the user's mailboxSettings. |
List Outlook categories | outlookCategory collection | Get all the categories defined for the user. |
Translate Exchange Ids | convertIdResult collection | Translate identifiers of Outlook-related resources between formats. |
Update user mailbox settings | mailboxSettings | Enable, configure, or disable one or more mailboxSettings for a user. |
Password-based single sign-on credentials | ||
getPasswordSingleSignOnCredentials | passwordSingleSignOnCredentialSet collection | Get the list of password-based single sign-on credentials for given user. Passwords are never returned, and instead are always returned as null or empty strings. |
deletePasswordSingleSignOnCredentials | None | Delete password-based single sign-on credential for a given service principal that is associated to a given user. |
People | ||
List people | person | Retrieve a list of person objects ordered by their relevance to the user, which is determined by the user's communication and collaboration patterns, and business relationships. |
Photo | ||
Get photo | profilePhoto | Get the specified profilePhoto or its metadata (profilePhoto properties). |
Update profilephoto | None | Update the photo for any user in the tenant, including the signed-in user or the specified group or contact. |
Delete profilephoto | None | Delete the photo for any user in the tenant, including the signed-in user or the specified group. |
Planner | ||
Get plannerUser | plannerUser | Retrieve the properties and relationships of a plannerUser object. |
List favoritePlans | plannerPlan collection | Retrieve a list of plannerPlans that are marked as favorite by a user. |
List recentPlans | plannerPlan collection | Retrieve a list of plannerPlans recently viewed by a user. |
List tasks | plannerTask collection | Get plannerTasks assigned to the user. |
Update plannerUser | None | Update the properties of a plannerUser object. |
Profile | ||
Get profile | profile | Retrieve the properties and relationships of a profile object for a given user. |
Delete profile | None | Delete profile object from a user's account. |
Schema extensions | ||
Add schema extension values | None | Create a schema extension definition and then use it to add custom-typed data to a resource. |
Sponsors | ||
Assign sponsors | None | Assign a user a sponsor. |
List sponsors | directoryObject collection | Get the users and groups who are this user's sponsors. |
Remove sponsors | None | Remove a user's sponsor. |
Teamwork | ||
List apps installed for user | userScopeTeamsAppInstallation collection | Lists apps installed in the personal scope of a user. |
Get the installed app for user | userScopeTeamsAppInstallation | Lists the specified app installed in the personal scope of a user. |
Add app for user | None | Adds (installs) an app in the personal scope of a user. |
Remove app for user | None | Removes (uninstalls) an app in the personal scope of a user. |
Upgrade app installed for user | None | Upgrades to the latest version of the app installed in the personal scope of a user. |
Get chat between user and app | Chat | Lists one-on-one chat between the user and the app. |
Get chat between user and app | Chat | Lists one-on-one chat between the user and the app. |
List permission grants | resourceSpecificPermissionGrant collection | List all resource-specific permission grants of a user. |
To-do tasks | ||
Create task | todoTask | Create a todoTask in the specified task list. |
Create task list | todoTaskList | Create a To Do task list in the user's mailbox. |
List tasks | todoTask collection | Get all the todoTask resources in the specified list. |
List task lists | todoTaskList collection | Get all the task lists in the user's mailbox. |
User settings | ||
Get settings | userSettings | Read the user and organization settings object. |
Update settings | userSettings | Update the properties of the settings object. |
Outlook tasks (deprecated) | ||
Create outlookTask (deprecated) | outlookTask | Create an Outlook task in the default task group (My Tasks) and default task folder (Tasks) in the user's mailbox. |
List tasks (deprecated) | outlookTask collection | Get all the Outlook tasks in the user's mailbox. |
Cloud PC | ||
List cloudPCs | cloudPC collection | List the cloudPC devices that are attributed to the signed-in user. |
Get launch info | cloudPCLaunchInfo | Get the cloudPCLaunchInfo for the signed-in user. |
Properties
Important
Specific usage of $filter
and the $search
query parameter is supported only when you use the ConsistencyLevel header set to eventual
and $count
. For more information, see Advanced query capabilities on directory objects.
Property | Type | Description |
---|---|---|
aboutMe | String | A freeform text entry field for users 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. Supports $filter (eq , ne , not , and in ). |
ageGroup | ageGroup | Sets the age group of the user. Allowed values: null , Minor , NotAdult , and Adult . For more information, see legal age group property definitions. 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 between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. 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. Supports $filter (eq and not ). |
authorizationInfo | authorizationInfo | Identifiers that can be used to identify and authenticate a user in non-Azure AD environments. This property can store identifiers for smartcard-based certificates that users use to access on-premises Active Directory deployments or federated access. It can also be used to store the Subject Alternate Name (SAN) that's associated with a Common Access Card (CAC). Nullable. Supports $filter (eq and startsWith ). |
birthday | DateTimeOffset | The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. 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. Only one number can be set for this property. Read-only for users synced from on-premises directory. Supports $filter (eq , not , ge , le , startsWith ). |
city | String | The city where the user is located. Maximum length is 128 characters. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
cloudRealtimeCommunicationInfo | cloudRealtimeCommunicationInfo | Microsoft realtime communication information related to the user. Supports $filter (eq , ne ,not ). |
companyName | String | The name of the company the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters. 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. Supports $filter (eq , ne , not , and in ). |
country | String | The country or region where the user is located; for example, US or UK . Maximum length is 128 characters. 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 UTC. 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 Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users synced to Microsoft Entra ID before June 2018. Read-only. Supports $filter (eq , ne , not , ge , le , in ). |
creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Supports $filter (eq , ne , not , and in ). |
customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select . Supports $filter (eq , ne , not , startsWith ). The filter value is case-sensitive. |
deletedDateTime | DateTimeOffset | The date and time the user was deleted. Supports $filter (eq , ne , not , ge , le , and in ). |
department | String | The name of the department where the user works. Maximum length is 64 characters. 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 value 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. 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 if there is a future hire. Supports $filter (eq , ne , not , ge , le , in ). |
employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader, or Global Administrator. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq , ne , not , ge , le , in ). For more information, see Configure the employeeLeaveDateTime property for a user. |
employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
employeeOrgData | employeeOrgData | Represents organization data (for example, division and costCenter) associated with a user. Supports $filter (eq , ne , not , ge , le , in ). |
employeeType | String | Captures enterprise worker type. For example, Employee , Contractor , Consultant , or Vendor . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
externalUserConvertedOn | DateTimeOffset | The date and time when the user was converted from external to internal. |
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. Supports $filter (eq , ne , not , in ). |
externalUserStateChangeDateTime | String | Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq , ne , not , in ). |
faxNumber | String | The fax number of the user. 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. 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. 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. It should be treated as an opaque identifier. Inherited from directoryObject. Not nullable. Read-only. 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. It may contain multiple items with the same signInType value. Supports $filter (eq ) with limitations. |
imAddresses | String collection | The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Supports $filter (eq , not , ge , le , startsWith ). |
infoCatalogs | String collection | Identifies the info segments assigned to the user. Supports $filter (eq , not , ge , le , startsWith ). |
interests | String collection | A list for users to describe their interests. Returned only on $select . |
isLicenseReconciliationNeeded | Boolean | Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only). |
isManagementRestricted | Boolean | true if the user is a member of a restricted management administrative unit, which requires a role scoped to the restricted administrative unit to manage. Default value is false . Read-only. To manage a user who is a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope. |
isResourceAccount | Boolean | Do not use – reserved for future use. |
jobTitle | String | The user's job title. Maximum length is 128 characters. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
lastPasswordChangeDateTime | DateTimeOffset | When this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. 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 . For more information, see legal age group property definitions. Returned only on $select . |
licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. It also indicates licenses that are directly assigned and the ones the user inherited through group memberships. Read-only. Returned only on $select . |
String | The SMTP address for the user, for example, admin@contoso.com . Changes to this property also update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. 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. For more information, see User preferences for languages and regional formats. 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. 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 the on-premises directory. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values) and $search . |
mySite | String | The URL for the user's site. Returned only on $select . |
officeLocation | String | The office location in the user's place of business. Maximum length is 128 characters. 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 synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. |
onPremisesDomainName | String | Contains the on-premises domainFQDN , also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. |
onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. false ), these properties can be set during the creation or update of a user object. Supports $filter (eq , ne , not , in ). |
onPremisesImmutableId | String | This property associates an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. Note: The $ and _ characters can't be used when specifying this property. 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. 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 synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Read-only. Supports $filter (eq including on null values). |
onPremisesSipInfo | onPremisesSipInfo | Contains all on-premises Session Initiation Protocol (SIP) information related to the user. Read-only. |
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 Microsoft Entra ID. Read-only. 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 synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
otherMails | String collection | A list of additional email addresses for the user; for example: ["bob@contoso.com", "Robert@fabrikam.com"] .NOTE: This property can't contain accent characters. 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 . For more information on the default password policies, see Microsoft Entra password 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. Supports $filter (eq , ne , not , in , and eq on null values). |
pastProjects | String collection | A list for users 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. 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. The preferred language format is based on RFC 4646. The name combines an ISO 639 two-letter lowercase culture code associated with the language and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". 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. Supports $filter (eq , not , ge , le ). |
proxyAddresses | String collection | For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"] . Changes to the mail property 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 the ones prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. 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 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 it happens, the application must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use invalidateAllRefreshTokens to reset. |
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 ). |
serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. |
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 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 must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. |
skills | String collection | A list for the user to enumerate their skills. Returned only on $select . |
signInActivity | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le ) but not with any other filterable properties. Note: |
state | String | The state or province in the user's address. Maximum length is 128 characters. 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. 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. 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 are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US , JP , and GB . Not nullable. 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 sign-in 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 alias@domain, where the domain must be present in the tenant's verified domain collection. 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 can't 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. 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. The possible values are Member and Guest . Supports $filter (eq , ne , not , in , and eq on null values). NOTE: For more information about the permissions for member and guest users, see What are the default user permissions in Microsoft Entra ID? |
Tip
Directory extensions and associated data are returned by default; schema extensions and associated data are returned only on $select
; and open extensions and associated data are returned only on $expand
.
mail and proxyAddresses properties
mail and proxyAddresses are both email-related properties. proxyAddresses is a collection of addresses only relevant to the Microsoft Exchange server. It's used to store a list of mail addresses for a user that are tied to a single mailbox. mail property is used as the user's email address for various purposes, including user sign-in, and defines the primary proxy address.
mail and proxyAddresses can be retrieved through the GET user API. You can update the mail via the Update user API, but you can't update proxyAddresses through Microsoft Graph. When a user's mail property is updated, it triggers a recalculation of proxyAddresses, and the newly updated mail is set to be the primary proxy address, except in the following scenarios:
- If a user has a license that includes Microsoft Exchange, all their proxy addresses must belong to a verified domain on the tenant. Any that don't belong to verified domains are silently removed.
- A user's mail will NOT be set to the primary proxy address if the user is a guest and the primary proxy address contains the guest user UPN string with
#EXT#
. - A user's mail will NOT be removed, even if they no longer have proxy addresses if the user is a guest.
proxyAddresses are unique across directory objects (users, groups, and organizational contacts). If a user's mail property conflicts with one of the proxyAddresses of another object, an attempt to update the mail fails, and the proxyAddresses property won't be updated either.
User preferences for languages and regional formats
The user resource contains a mailboxSettings property that includes the user's preferred language, date and time formatting, default time zone, and other settings specifically for their primary Exchange mailbox. These preferences are targeted at mail clients and are only available if the user has a mailbox provisioned. You can use mailboxSettings if your scenario focuses only on Outlook mail, calendar, contacts, or to-do tasks.
In addition to mailboxSettings, user includes a relationship via userSettings to regionalAndLanguageSettings, the superset of language and regional formatting preferences that can be used by any application to provide the user with the best language and regional formatting experience. Use userSettings for a consistent experience across apps that tap into the Microsoft Entra user profile to reflect the same user preferences.
Legal age group property definitions
This section explains how the three age group properties (legalAgeGroupClassification, ageGroup and consentProvidedForMinor) are used by Microsoft Entra administrators and enterprise application developers to meet age-related regulations:
- The legalAgeGroupClassification property is read-only. Enterprise application developers use it to ensure the correct handling of a user based on their legal age group. It's calculated based on the user's ageGroup and consentProvidedForMinor properties.
- ageGroup and consentProvidedForMinor are optional properties used by Microsoft Entra administrators to help ensure the use of an account is handled correctly based on the age-related regulatory rules governing the user's country or region.
For example, Cameron is an administrator of a directory for an elementary school in Holyport in the United Kingdom. At the beginning of the school year, he uses the admissions paperwork to obtain consent from the minor's parents based on the age-related regulations of the United Kingdom. The consent obtained from the parent allows the minor's account to be used by Holyport School and Microsoft apps. Cameron then creates all the accounts and sets ageGroup to "minor" and consentProvidedForMinor to "granted". Applications used by his students are then able to suppress features that aren't suitable for minors.
legalAgeGroupClassification values
Member | Description |
---|---|
null | Default value, no ageGroup has been set for the user. |
MinorWithoutParentalConsent | (Reserved for future use) |
MinorWithParentalConsent | The user is considered a minor based on the age-related regulations of their country or region, and the administrator of the account has obtained appropriate consent from a parent or guardian. |
Adult | The user is considered an adult based on the age-related regulations of their country or region. |
NotAdult | The user is from a country or region that has additional age-related regulations (such as the United States, United Kingdom, European Union, or South Korea), and the user's age is between a minor and an adult age (as stipulated based on country or region). Generally, this means that teenagers are considered as notAdult in regulated countries. |
MinorNoParentalConsentRequired | The user is a minor but is from a country or region that has no age-related regulations. |
ageGroup values
Member | Description |
---|---|
null | Default value, no ageGroup has been set for the user. |
Minor | The user is considered a minor. |
NotAdult | The user is from a country that has statutory regulations United States, United Kingdom, European Union or South Korea) and user's age is more than the upper limit of kid age (as per country) and less than lower limit of adult age (as stipulated based on country or region). So basically, teenagers are considered as notAdult in regulated countries. |
Adult | The user should be a treated as an adult. |
consentProvidedForMinor values
Member | Description |
---|---|
null | Default value, no consentProvidedForMinor has been set for the user. |
Granted | Consent has been obtained for the user to have an account. |
Denied | Consent hasn't been obtained for the user to have an account. |
NotRequired | The user is from a location that doesn't require consent. |
Relationships
Relationship | Type | Description |
---|---|---|
activities | userActivity collection | The user's activities across devices. Read-only. Nullable. |
agreementAcceptances | agreementAcceptance collection | The user's terms of use acceptance statuses. Read-only. Nullable. |
appRoleAssignments | appRoleAssignment collection | Represents the app roles a user has been granted for an application. Supports $expand . |
authentication | authentication | The authentication methods that are supported for the user. |
calendar | calendar | The user's primary calendar. Read-only. |
calendarGroups | calendarGroup collection | The user's calendar groups. Read-only. Nullable. |
calendarView | event collection | The calendar view for the calendar. Read-only. Nullable. |
calendars | calendar collection | The user's calendars. Read-only. Nullable. |
contactFolders | contactFolder collection | The user's contacts folders. Read-only. Nullable. |
contacts | contact collection | The user's contacts. Read-only. Nullable. |
createdObjects | directoryObject collection | Directory objects that the user created. Read-only. Nullable. |
directReports | directoryObject collection | The users and contacts that report to the user. (The users and contacts with their manager property set to this user.) Read-only. Nullable. Supports $expand . |
drive | drive | The user's OneDrive. Read-only. |
drives | drive collection | A collection of drives available for this user. Read-only. |
events | event collection | The user's events. The default is to show events under the Default Calendar. Read-only. Nullable. |
extensions | extension collection | The collection of open extensions defined for the user. Supports $expand . Nullable. |
inferenceClassification | inferenceClassification | Relevance classification of the user's messages based on explicit designations that override inferred relevance or importance. |
insights | itemInsights | Read-only. Nullable. |
joinedGroups | group collection | Read-only. Nullable. |
mailFolders | mailFolder collection | The user's mail folders. Read-only. Nullable. |
manager | directoryObject | The user or contact that is this user's manager. Read-only. Supports $expand . |
memberOf | directoryObject collection | The groups, directory roles, and administrative units that the user is a member of. Read-only. Nullable. Supports $expand . |
joinedTeams | team collection | The Microsoft Teams teams the user is a member of. Read-only. Nullable. |
messages | message collection | The messages in a mailbox or folder. Read-only. Nullable. |
onenote | onenote | Read-only. |
onlineMeetings | onlineMeeting collection | Information about a meeting, including the URL used to join a meeting, the attendees list, and the description. |
outlook | outlookUser | Selective Outlook services available to the user. Read-only. Nullable. |
ownedDevices | directoryObject collection | Devices owned by the user. Read-only. Nullable. Supports $expand . |
ownedObjects | directoryObject collection | Directory objects owned by the user. Read-only. Nullable. Supports $expand , $select nested in $expand , and $filter (/$count eq 0 , /$count ne 0 , /$count eq 1 , /$count ne 1 ). |
pendingAccessReviewInstances | accessReviewInstance collection | Navigation property to get a list of access reviews pending approval by the reviewer. |
people | person collection | Read-only. The most relevant people to the user. The collection is ordered by their relevance to the user, which is determined by the user's communication, collaboration, and business relationships. A person aggregates information from mail, contacts, and social networks. |
permissionGrants | resourceSpecificPermissionGrant collection | List all resource-specific permission grants of a user. |
photo | profilePhoto | The user's profile photo. Read-only. |
photos | profilePhoto collection | The collection of the user's profile photos in different sizes. Read-only. |
planner | plannerUser | Selective Planner services available to the user. Read-only. Nullable. |
profile | profile | Represents properties that are descriptive of a user in a tenant. |
registeredDevices | directoryObject collection | Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects. |
scopedRoleMemberOf | scopedRoleMembership collection | The scoped-role administrative unit memberships for this user. Read-only. Nullable. |
security | security | Nullable. |
settings | userSettings | Read-only. Nullable. |
sponsors | directoryObject collection | The users and groups responsible for this guest user's privileges in the tenant and keep the guest user's information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand . |
teamwork | userTeamwork | A container for Microsoft Teams features available for the user. Read-only. Nullable. |
todo | todo | Represents the To Do services available to a user. |
transitiveMemberOf | directoryObject collection | The groups, including nested groups and directory roles that a user is a member of. Nullable. |
transitiveReports | directoryObject collection | The transitive reports for a user. Read-only. |
usageRights | usageRight collection | Represents the usage rights a user has been granted. |
JSON representation
The following is a JSON representation of the resource.
{
"aboutMe": "String",
"accountEnabled": true,
"ageGroup": "String",
"assignedLicenses": [{"@odata.type": "microsoft.graph.assignedLicense"}],
"assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
"authorizationInfo": {
"@odata.type": "microsoft.graph.authorizationInfo"
},
"birthday": "String (timestamp)",
"businessPhones": ["String"],
"city": "String",
"cloudRealtimeCommunicationInfo": {
"@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
},
"companyName": "String",
"consentProvidedForMinor": "String",
"country": "String",
"createdDateTime": "2019-02-07T21:53:13.067Z",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"deletedDateTime": "String (timestamp)",
"department": "String",
"displayName": "String",
"employeeHireDate": "2020-01-01T00:00:00Z",
"employeeId": "String",
"employeeLeaveDateTime": "String (timestamp)",
"employeeOrgData": {"@odata.type": "microsoft.graph.employeeOrgData"},
"employeeType": "String",
"externalUserConvertedOn": "String (timestamp)",
"externalUserState": "PendingAcceptance",
"externalUserStateChangeDateTime": "2018-11-12T01:13:13Z",
"faxNumber": "String",
"givenName": "String",
"hireDate": "String (timestamp)",
"id": "String (identifier)",
"identities": [{"@odata.type": "microsoft.graph.objectIdentity"}],
"interests": ["String"],
"isLicenseReconciliationNeeded": false,
"isResourceAccount": false,
"jobTitle": "String",
"legalAgeGroupClassification": "String",
"licenseAssignmentStates": [{"@odata.type": "microsoft.graph.licenseAssignmentState"}],
"mail": "String",
"mailboxSettings": {"@odata.type": "microsoft.graph.mailboxSettings"},
"mailNickname": "String",
"mobilePhone": "String",
"mySite": "String",
"officeLocation": "String",
"onPremisesDistinguishedName": "String",
"onPremisesDomainName": "String",
"onPremisesExtensionAttributes": {"@odata.type": "microsoft.graph.onPremisesExtensionAttributes"},
"onPremisesImmutableId": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesProvisioningErrors": [{"@odata.type": "microsoft.graph.onPremisesProvisioningError"}],
"onPremisesSamAccountName": "String",
"onPremisesSecurityIdentifier": "String",
"onPremisesSipInfo": {
"@odata.type": "microsoft.graph.onPremisesSipInfo"
},
"onPremisesSyncEnabled": true,
"onPremisesUserPrincipalName": "String",
"otherMails": ["String"],
"passwordPolicies": "String",
"passwordProfile": {"@odata.type": "microsoft.graph.passwordProfile"},
"pastProjects": ["String"],
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"preferredName": "String",
"provisionedPlans": [{"@odata.type": "microsoft.graph.provisionedPlan"}],
"proxyAddresses": ["String"],
"refreshTokensValidFromDateTime": "2019-02-07T21:53:13.084Z",
"responsibilities": ["String"],
"schools": ["String"],
"securityIdentifier": "String",
"serviceProvisioningErrors": [{"@odata.type": "microsoft.graph.serviceProvisioningXmlError"}],
"showInAddressList": true,
"signInSessionsValidFromDateTime": "2019-02-07T21:53:13.084Z",
"skills": ["String"],
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"calendar": {"@odata.type": "microsoft.graph.calendar"},
"calendarGroups": [{"@odata.type": "microsoft.graph.calendarGroup"}],
"calendarView": [{"@odata.type": "microsoft.graph.event"}],
"calendars": [{"@odata.type": "microsoft.graph.calendar"}],
"contacts": [{"@odata.type": "microsoft.graph.contact"}],
"contactFolders": [{"@odata.type": "microsoft.graph.contactFolder"}],
"createdObjects": [{"@odata.type": "microsoft.graph.directoryObject"}],
"directReports": [{"@odata.type": "microsoft.graph.directoryObject"}],
"drive": {"@odata.type": "microsoft.graph.drive"},
"drives": [{"@odata.type": "microsoft.graph.drive"}],
"insights": {"@odata.type": "microsoft.graph.itemInsights"},
"settings": {"@odata.type": "microsoft.graph.userSettings"},
"events": [{"@odata.type": "microsoft.graph.event"}],
"extensions": [{"@odata.type": "microsoft.graph.extension"}],
"inferenceClassification": {"@odata.type": "microsoft.graph.inferenceClassification"},
"mailFolders": [{"@odata.type": "microsoft.graph.mailFolder"}],
"manager": {"@odata.type": "microsoft.graph.directoryObject"},
"memberOf": [{"@odata.type": "microsoft.graph.directoryObject"}],
"joinedTeams": [{"@odata.type": "microsoft.graph.group"}],
"teamwork": {"@odata.type": "microsoft.graph.teamwork"},
"messages": [{ "@odata.type": "microsoft.graph.message"}],
"outlook": {"@odata.type": "microsoft.graph.outlookUser"},
"ownedDevices": [{"@odata.type": "microsoft.graph.directoryObject"}],
"photo": {"@odata.type": "microsoft.graph.profilePhoto"},
"photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
"profile": {"@odata.type": "microsoft.graph.profile"},
"registeredDevices": [{"@odata.type": "microsoft.graph.directoryObject"}],
"signInActivity": {"@odata.type": "microsoft.graph.signInActivity"}
}
Related content
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per