Search Groups

Search Office 365 for a group by property values. Supported search operations include Exact Match and Starts With. An Exact Match search returns groups whose properties match exactly, while Starts With searches return groups whose properties start with that value.

Caution

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

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 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
Note

The input field properties that display for Exact Match are different from the input field properties for Starts With.

Input

Field Definition Type Required
Group
Display Name Display name for the group. String FALSE
Group Types Specifies the group type and its membership. Dropdown FALSE
Mail SMTP address for the group. String FALSE
Mail Enabled True: the group is mail-enabled. False: the group is not mail-enabled. Boolean FALSE
Mail Nickname Mail alias for the group, unique in the organization. String 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. Boolean 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 Timestamp when the group was created. Date & Time
Display Name Display name for the group. String
Id Unique identifier for the group. String
Mail SMTP address for the group. String
Mail Nickname Mail alias for the group, unique in the organization. String
Classification Classification for the group (such as low, medium, or high business impact). String
Description Optional description for the group. String
Group Types Specifies the group type and its membership. List of Text
License Processing State Indicates status of the group license assignment to all members of the group. String
Mail Enabled? Specifies whether the group is mail-enabled Boolean
On Premises Security Identifier Contains the on-premises security identifier (SID) for the group 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
Preferred Data Location Preferred data location for the group. String
Proxy Addresses Email addresses for the group that direct to the same group mailbox. List of Text
Renewed Date Time Timestamp 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. Boolean
Visibility Specifies the group join policy and group content visibility for groups. String

Related topics

Office 365 Admin connector

Elements of Workflows

Guidance for Office 365 Admin connector

Office 365 Admin Management API overview