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.

Note: The Search Groups action returns a maximum of 4000 groups.

Unless otherwise indicated, field types are text.

Options

  • Result Set (dropdown): 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.

  • Search By (dropdown): 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. Note: This operator will be applied to all properties, which means that if you choose Exact Match, then all input field properties must match in order to return results. Similarly, choosing Starts With means that all input field properties will be queried using the 'Starts With' operator. Currently, you cannot choose to perform Exact Match and Starts With searches using multiple properties on a single Search Groups action.

Input

  • Group

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

    • Classification: This is the classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a group setting classification list using the group settings template. See groupSetting and groupSettingTemplate.

    • Display Name: The display name for the group. This property is required when a group is created and cannot be cleared during updates.

    • Group Types (dropdown): Search for Office 365 or Security groups.

      • Office 365 Group: Return all Office 365 groups.

      • Security Group: Return all security groups.

    • Has Members With License Errors (true/false): Indicates whether there are members in this group that have license errors from its group-based license assignment.

    • Id: The unique identifier for the group.

    • License Processing State: Indicates the status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

    • Mail: The SMTP address for the group, for example, serviceadmins@contoso.onmicrosoft.com.

    • Mail Enabled (true/false): true: the group is mail-enabled. false: the group is not mail-enabled.

    • Mail Nickname: The mail alias for the group, unique in the organization.

    • On Premises Last Sync Date Time:This is when the group 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 Security Identifier: Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

    • On Premises Sync Enabled (true/false): true if this group is synced from an on-premises directory; false if this group 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).

    • Preferred Data Location: The preferred data location for the group. See OneDrive Online Multi-Geo.

    • Proxy Addresses (list of text): Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. The any operator is required to filter expressions on multi-valued properties.

    • Security Enabled (true/false): Specifies whether the group is a security group.

    • Unseen Count (number): The number of conversations that have received new posts since the signed-in user last visited the group.

Output

  • Result

    • Id: The unique identifier for the group.

    • Display Name: The display name for the group.

See also