Read User

Read an Office 365 user's properties by User ID or Email.

Unless otherwise indicated, field types are text.

Input

  • User

    • Id or Username: The user ID or username of the Office 365 user. This is the user's User Principal Name (UPN). A UPN is formed by taking the username and domain and combining them with the @ separator, for example, john.doe@somedomain.com. This could be the user's email address, but this is not true in all cases.

Output

  • User

    • About Me: A field for the user to describe themselves.

    • Account Enabled (true/false): true if the account is enabled; otherwise, false.

    • Age Group: The age group of the user. Allowed values: null, minor, notAdult and adult.

    • Assigned Licenses (list of objects): The licenses that are assigned to the user.

    • Assigned Plans (list of objects): The plans that are assigned to the user.

    • Birthday: The user's birthday. This is a timestamp value that follows the ISO 8601 format and is in UTC time. For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z.

    • Business Phones (list of text): The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property.

    • City: The city in which the user is located.

    • Company Name: The company name which the user is associated. This property can be useful for describing the company that an external user comes from.

    • Consent Provided For Minor: Whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired.

    • Country: The country or region in which the user is located; for example, US or UK.

    • Created Date Time: The created date of the user object.

    • Department: The name for the department in which the user works.

    • Display Name: 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.

    • Employee Id: The employee identifier assigned to the user by the organization.

    • Fax Number: The fax number of the user.

    • Given Name: The given name (first name) of the user.

    • Hire Date: The user's hire date. This is a timestamp value that follows the ISO 8601 format and is in UTC time. For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z.

    • Id: The unique identifier for the user.

    • Im Addresses (list of text): The instant message (IM) voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.

    • Interests (list of text): A list of the user's interests.

    • Is Resource Account (true/false): true if the user is a resource account; otherwise, false. null value should be considered false.

    • Job Title: The user's job title.

    • Legal Age Group Classification: Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on Age Group and Consent Provided For Minor properties. Allowed values: null, minorWithOutParentalConsent, minorWithParentalConsent, minorNoParentalConsentRequired, notAdult and adult.

    • License Assignment States (list of objects): State of license assignments for this user.

    • Mail: The SMTP address for the user, for example, jeff@contoso.onmicrosoft.com.

    • Mail Nickname: The mail alias for the user.

    • Mobile Phone: The primary cellular telephone number for the user.

    • My Site: The URL for the user's personal site.

    • Office Location: The office location in the user's place of business.

    • On Premises Distinguished Name: 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 using Azure AD Connect.

    • On Premises Domain Name: Contains the on-premises Fully Qualified Domain Name, 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 using Azure AD Connect.

    • On Premises Extension Attributes (object): Contains Extension Attributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an On Premises Sync Enabled user, this set of properties is mastered on-premises and is read-only. For a cloud-only user (where On Premises Sync Enabled is false), these properties may be set during creation or update.

    • On Premises Immutable Id: 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 User Principal Name (UPN) property.

    • On Premises Last Sync Date Time: This is when the object was last synced with the on-premises directory. This is a timestamp value that follows the ISO 8601 format and is in UTC time. For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z.

    • On Premises Provisioning Errors (list of objects): Errors when using Microsoft synchronization product during provisioning.

    • On Premises Sam Account Name: Contains the on-premises Sam Account Name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect.

    • On Premises Security Identifier: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud.

    • On Premises Sync Enabled (true/false): 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; null if this object has never been synced from an on-premises directory (default).

    • On Premises User Principal Name: Contains the on-premises User PrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect.

    • Other Mails: A list of additional email addresses for the user.

    • Password Policies: This specifies the password policies for the user. "DisableStrongPassword" allows weaker passwords than the default policy to be used. "DisablePasswordExpiration" sets the user's password to never expire. You can specify both by entering "DisablePasswordExpiration, DisableStrongPassword".

    • Password Profile (object): 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.

    • Past Projects (list of text): A list for the user to enumerate their past projects.

    • Postal Code: The postal code for the user's postal address. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code.

    • Preferred Data Location: The preferred data location for the user.

    • Preferred Language: The user's preferred language. This is an ISO 639-1 code. For example, en-US, ja, sp, and so on.

    • Preferred Name: The preferred name for the user.

    • Provisioned Plans (list of objects): The plans that are provisioned for the user.

    • Proxy Address (list of text): List of user proxy addresses. For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. The any operator is required for filter expressions on multi-valued properties.

    • Responsibilities (list of text): A list for the user to enumerate their responsibilities.

    • Schools (list of text): A list for the user to enumerate the schools they have attended.

    • Show In Address List (true/false): true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false.

    • Skills (list of text): A list for the user to enumerate their skills.

    • Sign In Sessions Valid From Date Time: 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.

    • State: The state or province in the user's address.

    • Street Address: The street address of the user's place of business.

    • Surname: The user's surname (family name or last name).

    • Usage Location: A two letter country code defined by ISO 3166. This is required for users that will be assigned licenses, due to a legal requirement to check for availability of services in a country. For example, US, JP, and GB.

    • User Principal Name: The User Principal Name (UPN) of the user. This is an internet-style login name for the user based on RFC 822. Its format is alias@domain, where domain must be present in the tenant's collection of verified domains. This is sometimes the same as the user's email address.

    • User Type: A string value that can be used to classify user types in your directory, such as Member and Guest.

    • Activities (list of objects): The user's activities across devices.

    • Calendar (object): The user's primary calendar.

    • Calendar Groups (list of objects): The user's calendar groups.

    • Calendar View (list of objects): The calendar view for the calendar.

    • Calendars (list of objects): The user's calendars.

    • Contact Folders (_list of objects): The user's contacts folders.

    • Contacts (list of objects): The user's contacts.

    • Created Objects (list of objects): Directory objects that were created by the user.

    • Direct Reports (list of objects): The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.)

    • Drive (object): The user's OneDrive.

    • Drives (list of objects): A collection of drives available for this user.

    • Events (list of objects): The user's events. Default is to show Events under the Default Calendar.

    • Extensions (list of objects): The collection of open extensions defined for the user.

    • Inference Classification (object): Relevance classification of the user's messages based on explicit designations which override inferred relevance or importance.

    • License Details (list of objects): A collection of this user's license details.

    • Mail Folders (list of objects): The user's mail folders.

    • Manager (object): The user or contact that is this user's manager.

    • Member Of (list of objects): The groups and directory roles that the user is a member of.

    • Messages (list of objects): The messages in a mailbox or folder.

    • Onenote (object): The user's OneNote resource.

    • Outlook (object): The user's Outlook resource.

    • Owned Devices (list of objects): Devices that are owned by the user.

    • Owned Objects (list of objects): Directory objects that are owned by the user.

    • People (list of objects): People that are relevant to the user.

    • Photo (object): The user's profile photo.

    • Planner (object): Entry-point to the Planner resource that might exist for a user.

    • Registered Devices (list of objects): Devices that are registered for the user.

See also