Search Groups

Search Azure Active Directory for a group by property values.

An Exact Match search returns groups whose properties match exactly, while Starts With searches return groups whose properties start with that value.

The Search Groups action card returns a maximum of 4,000 groups.

Options

Field	Definition	Type	Required
Result Set	Choose to return either 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	Choose the search operator when searching for groups. Exact Match: Returns groups whose properties are exactly equal to the input values. Starts With: Returns groups whose properties start with the input values.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose to return either 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

Choose the search operator when searching for groups.

Exact Match: Returns groups whose properties are exactly equal to the input values.
Starts With: Returns groups 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
Group
Display Name	Display name for the group.	Text	FALSE
Group Types	Specifies the group type and its membership.	Dropdown	FALSE
Mail	SMTP address for the group.	Text	FALSE
Mail Enabled	Specifies if the group has mail enabled.	True/False	FALSE
Mail Nickname	Mail alias for the group, unique in the organization.	Text	FALSE
Proxy Addresses	Email addresses for the group that direct to the same group mailbox.	List of Text	FALSE
Security Enabled	Specifies whether the group is a security group.	True/False	FALSE

Output

Field	Definition	Type
Groups
Assigned Licenses	Licenses that are assigned to the user, including inherited (group-based) licenses.	List of Objects
Created Date Time	Time stamp when the group was created.	Date & Time
Display Name	Display name for the group.	Text
Id	Unique identifier for the group.	Text
Mail	SMTP address for the group.	Text
Mail Nickname	Mail alias for the group, unique in the organization.	Text
Classification	Classification for the group (such as low, medium, or high business impact).	Text
Description	Optional description for the group.	Text
Group Types	Specifies the group type and its membership.	List of Text
License Processing State	Indicates the status of the group license assigned to all members of the group.	Text
Mail Enabled?	Specifies whether the group is mail-enabled	True/False
On Premises Security Identifier	Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.	Text
On Premises Sync Enabled?	Specifies if the object is synced from on-premises directory. true: The object is synced from an on-premises directory false: The object was originally synced from an on-premises directory but is no longer synced null: This object has never been synced from an on-premises directory (default)	True/False
Preferred Data Location	Preferred data location for the group.	Text
Proxy Addresses	Email addresses for the group that direct to the same group mailbox.	List of Text
Renewed Date Time	Time stamp of when the group was last renewed. For example, 2014-01-01T00:00:00Z.	Date & Time
Security Enabled?	Specifies whether the group is a security group.	True/False
Visibility	Specifies the group join policy and group content visibility for groups.	Text

Search Groups

Options

Input

Output

Related topics