Read User

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

Input

Field Definition Type Required
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.

String TRUE

Output

Field Definition Type
User
About Me A field for the user to describe themselves. String
Account Enabled true if the account is enabled; otherwise, false. Boolean
Age Group The age group of the user. Allowed values: null, minor, notAdult and adult. String
Assigned Licenses The licenses that are assigned to the user. list of objects
Assigned Plans The plans that are assigned to the user. list of objects
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. String
Business Phones

The telephone numbers for the user.

Note

Although this is a string collection, only one number can be set for this property.

List of text
City The city in which the user is located. String
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. String
Consent Provided For Minor Whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. String
Country The country or region in which the user is located; for example, US or UK. String
Created Date Time The created date of the user object. String
Department The name for the department in which the user works. String
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. String
Employee Id The employee identifier assigned to the user by the organization. String
Fax Number The fax number of the user. String
Given Name The given name (first name) of the user. String
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. String
Id The unique identifier for the user. String
Im Addresses The instant message (IM) voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. List of text
Interests A list of the user's interests. List of text
Is Resource Account true if the user is a resource account; otherwise, false. null value should be considered false. Boolean
Job Title The user's job title. String
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. String
License Assignment States State of license assignments for this user. List of objects
Mail The SMTP address for the user, for example, jeff@contoso.onmicrosoft.com. String
Mail Nickname The mail alias for the user. String
Mobile Phone The primary cellular telephone number for the user. String
My Site The URL for the user's personal site. String
Office Location The office location in the user's place of business. String
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. String
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. String
On Premises Extension Attributes 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 on-premises-sourced 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. Object
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. String
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. String
On Premises Provisioning Errors Errors when using Microsoft synchronization product during provisioning. List of objects
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. String
On Premises Security Identifier Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. String
On Premises Sync Enabled 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). Boolean
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. String
Other Mails A list of additional email addresses for the user. String
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". String
Password Profile 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. Object
Past Projects A list for the user to enumerate their past projects. List of text
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. String
Preferred Data Location The preferred data location for the user. String
Preferred Language The user's preferred language. This is an ISO 639-1 code. For example, en-US, ja, sp, and so on. String
Preferred Name The preferred name for the user. String
Provisioned Plans The plans that are provisioned for the user. List of objects
Proxy Address 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. List of text
Responsibilities A list for the user to enumerate their responsibilities. List of text
Schools A list for the user to enumerate the schools they have attended. List of text
Show In Address List 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. Boolean
Skills A list for the user to enumerate their skills. List of text
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. String
State The state or province in the user's address. String
Street Address The street address of the user's place of business. String
Surname The user's surname (family name or last name). String
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. String
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. String
User Type A string value that can be used to classify user types in your directory, such as Member and Guest. String

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management APIs overview