Search Users

Search Azure Active Directory for a user by property values.

Supported search operations include Exact Match and Starts With. An Exact Match returns users whose properties match exactly, while Starts With returns users whose properties start with that value.

The Search Users action card returns a maximum of 4,000 users.

Options

Field Definition Type Required
Result Set

Choose to return the First Matching Record, or return All Matching Records, which returns a list of objects as the output field on the card.

 Dropdown TRUE
Search By

  • Exact Match returns users whose properties are exactly equal to the input values.

  • Starts With returns users whose properties start with the input values.

 Dropdown TRUE

The input field properties shown for an Exact Match differ from the input field properties for Starts With.

Input

Field Definition Type Required
Search
Account Enabled?

True if the account is enabled; otherwise, False.

 Boolean FALSE
Age Group

Age group of the user. Allowed values: Null, Minor, Not Adult, and Adult.

 Dropdown FALSE
City

City in which the user is located.

 String FALSE
Consent Provided For Minor

Indicates whether consent has been obtained for minors. Allowed values: Null, Granted, Denied, and Not Required.

 Dropdown FALSE
Country

Country or region in which the user is located.

For example, US or UK.

 String FALSE
Department

Name for the department in which the user works.

 String FALSE
Display Name

Name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates.

 String FALSE
Employee Id

Employee identifier assigned to the user by the organization.

 String FALSE
Given Name

Given name (first name) of the user.

 String FALSE
IM Addresses

Instant message (IM), voice over IP (VOIP), and session initiation protocol (SIP) addresses for the user.

 List of Text FALSE
Job Title

User's job title.

 String FALSE
Mail

SMTP address for the user.

 String FALSE
Mail Nickname

Mail alias for the user.

 String FALSE
On Premises Immutable Id

Used to associate an on-premises Active Directory user account to their Azure Active Directory user object.

 String FALSE
On Premises User Principal Name

Contains the on-premises User Principal 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 Active Directory Connect.

 String FALSE
Other Mails

List of other email addresses for the user.

 List of Text FALSE
Proxy Address

List of user proxy addresses.

 List of Text FALSE
State

State or province in the user's address.

 String FALSE
Surname

User's surname (family name or last name).

 String FALSE
Usage Location (2 char)

Two letter country code (ISO standard 3166).

For example, US, JP, and GB.

 String FALSE
User Principal Name

User Principal Name (UPN) of the user. This is an internet-style login name for the user based on 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 collection of verified domains.

 String FALSE
User Type

String value that can be used to classify user types in your directory.

For example, Member and Guest.

 Dropdown FALSE

Output

Field Definition Type
Account Enabled?

True if the account is enabled; otherwise, False.

 Boolean
Age Group

Age group of the user.

 String
Assigned Licenses

Licenses that are assigned to the user, including inherited (group-based) licenses.

 List of Objects
Assigned Plans

Plans that are assigned to the user.

 List of Objects
Business Phones

Phone numbers for the user.

List of Text
City

City in which the user is located.

 String
Company Name

Company name associated with the user.

 String
Consent Provided For Minor

Indicates whether consent has been obtained for minors.

 String
Country

Country or region in which the user is located.

For example, US or UK.

 String
Created Date Time

Created date and time of the user object.

 Date & Time
Department

Name for the department in which the user works.

 String
Display Name

Name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and family name.

 String
Employee Id

Employee identifier assigned to the user by the organization.

 String
Fax Number

Fax number of the user.

 String
Given Name

Given name (first name) of the user.

 String
Id

Unique identifier for the user.

 String
Im Addresses

Instant message (IM), voice over IP (VOIP), and session initiation protocol (SIP) addresses for the user.

 List of Text
Job Title

User's job title.

 String
Legal Age Group Classification

Used by enterprise applications to determine the legal age group of the user.

 String
License Assignment States

State of license assignments for this user.

 List of Objects
Mail

SMTP address for the user.

 String
Mail Nickname

Mail alias for the user.

 String
Mobile Phone

Primary cellular phone number for the user.

 String
Office Location

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 Active Directory Connect.

 String
On Premises Domain Name

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 using Azure Active Directory Connect.

 String
On Premises Extension Attributes

Contains extensionAttributes 1–15 for the user.

 Object
On Premises Immutable Id

Associate an on-premises Active Directory user account to their Azure Active Directory user object.

 String
On Premises Last Sync Date Time

Specifies the last time at which the object was synced with the on-premises directory.

 Date & Time
On Premises Provisioning Errors

Errors when using Microsoft synchronization product during provisioning.

 List of Objects
On Premises Sam Account Name

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 using Azure Active Directory 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 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 using Azure Active Directory Connect.

 String
Other Mails

List of other email addresses for the user.

 List of Text
Password Policies

Specifies password policies for the user.

 String
Password Profile

Specifies the password profile for the user. The profile contains the user's password.

 Object
Postal Code

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 Language

Preferred language for the user.

 String
Provisioned Plans

Plans that are provisioned for the user.

 List of Objects
Proxy Addresses

List of user proxy addresses.

 List of Text
Show In Address List?

True if the Outlook global address list should contain this user, otherwise False. If not set, this is treated as True. For users invited through the invitation manager, this property is set to False.

 Boolean
Sign In Sessions Valid From Date Time

Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid.

 Date & Time
State

State or province in the user's address.

 String
Street Address

Street address of the user's place of business.

 String
Surname

User's surname (family name or last name).

 String
Usage Location

Two letter country code (ISO standard 3166).

For examples, US, JP, and GB.

 String
User Principal Name

User principal name (UPN) of the user.

 String
User Type

Value used to classify user types in your directory.

For example, Member and Guest

 String

Related topics

Azure Active Directory connector

Workflow elements

Guidance for Azure Active Directory connector

Azure Active Directory Management API overview