Search Teams

Search for Microsoft Teams.

Options

Field Definition Type Required
Result Set Choose one of the following options to display your search results:
  • First Matching Record: returns the first matching teams.
  • First 200 Matching Records: returns the first 200 matching teams.
  • Stream Matching Records: pass all matching records from your parent flow to a helper flow. This adds a Streaming input section to the card where you can select a helper flow for streaming and adding custom extensible fields.
Dropdown TRUE
Search By Choose whether to return teams that are an Exact Match of the search or Starts With the search expression. Dropdown TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

The input field properties shown for the Exact Match option differ from those displayed for the Starts With option.

Field Definition Type Required
Search
Display Name The display name for the team. String FALSE
Group Types Specifies the group type. Choose from: Office 365 Group or Security Group. Dropdown FALSE
Mail SMTP address for the team. String FALSE
Mail Enabled? Specify whether the group is mail-enabled. Choose from true or false. Dropdown FALSE
Mail Nickname Mail alias for the group, unique in the organization.

This property must be specified when a team is created.

These characters can't be used: @()\[]";:.<>, or a blank space.

String FALSE
Proxy Addresses Email addresses for the team that direct to the same group mailbox. List of Text FALSE
Renewed Date Time The time stamp of when the group was last renewed.

For example, 2014-01-01T00:00:00Z.

Date and Time FALSE
Security Enabled? Specifies whether the group is a security group. Boolean FALSE
Streaming

Appears when Stream Matching Records is selected from the Result Set option.

Flow Click Choose Flow to browse and select a helper flow to which the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

Flow TRUE
Search Criteria

Appears when Stream Matching Records is selected from the Result Set option.

Record Limit

Specify the number of records to stream.

  • When the Record Limit field is set to 0, the card returns a 400 Bad Request error.

  • When the Record Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 4900000 (4.9 million).

  • The valid range is 1 to 4900000.

Number FALSE

Output

Field Definition Type
Teams
Id Unique identifier for the team. String
Display Name The display name for the team. String
Resource Provisioning Specifies the group resources that are provisioned as part of the Microsoft 365 group creation, that aren't normally part of default group creation. A possible value is Team. List of Strings
Mail SMTP address for the group. String
Mail Nickname Mail alias for the group, unique in the organization. String
Assigned Licenses Licenses that are assigned to the group. Collection
Disabled Plans Collection of the unique identifiers for plans that have been disabled. String
SKU Id SKU identifier of the service plan. String
Classification Describes the data or business sensitivity of the team. This value must match one of a pre-configured set in the tenant's directory. String
Created Date Time Time stamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Time stamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Date and Time
Description Description for the team. String
Group Types Indicates Microsoft Teams group type. List of Strings
License Processing State Indicates the status of the group license assignment to all members of the team.

For example: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

String
Mail Enabled? If true, the group is mail-enabled. Boolean
On Premises Security The on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. String
On Premises Sync

If true, this group is synced from an on-premises directory.

Returns false if this group was originally synced from an on-premises directory but is no longer synced and 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.

For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. The any operator is required to filter expressions on multi-valued properties.

List of Text
Renewed Date Time The time stamp of when the group was last renewed. This can't be modified directly and is only updated through the renew service action. The Time stamp type represents date and time information using ISO 8601 format and is always in UTC time.

For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Date and Time
Security Enabled? If true, the group is a security group. Boolean
Visibility Visibility of the group and team.

For example, Public or Private.

String
Records Streamed Specified the number of streamed records. Number

Related topics

Microsoft Teams connector

Workflow elements

Guidance for Microsoft Teams connector

Microsoft Teams API overview