Search Group Members

List the members of a group in Office 365.

Options

Field Definition Type Required
Result Set Choose one of the following options to display your search results:

  • First Matching Record: returns a single user record

  • First 900 Matching Records: returns the first 900 records that match the search criteria

  • Stream Matching Records: pass all matching user records from your parent flow to a helper flow; a Streaming input section will be added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

 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.

  • Query returns group members using Microsoft Graph query parameters. See Use query parameters to customize responses. parameters. Option is available only if Stream Matching Users is selected from the Result Set dropdown.

For example, to query users whose city is Philadelphia and whose first name is John, use the query $filter = city eq 'Philadelphia' and displayName eq 'John'.

 Dropdown TRUE
Tip

To learn how to use the Stream Matching Records option and set up a helper flow to return a large number of records, see Set up the stream matching option with a helper flow.

Note

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

Caution

An input value cannot contain a # hash character.

Input

Field Definition Type Required
User
Id or Username User ID or username of the Office 365 user. This is the user's User Principal Name (UPN). A UPN is formed by taking the username and domain and combining them with the @ separator.

For example, john.doe@somedomain.com. This could be the user’s email address, but this is not true in all cases.

String TRUE

Input

Field Definition Type Required
Group  
ID Unique identifier for the group. String TRUE
Search  
Account Enabled True if the account is enabled; otherwise, false. Dropdown 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 if consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. String 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 last name. 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
Job Title User's job title. String FALSE
Mail SMTP address for the user.

For example, jeff@contoso.onmicrosoft.com.

 String FALSE
Mail Nickname Mail alias for the user. String FALSE
On Premises Immutable ID Property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's User Principal Name (UPN) property. String FALSE
On Premises User Principal Name Contains the on-premises User PrincipalName 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 AD Connect. String 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 A two letter country code defined by ISO 3166. This is required for users that will be assigned licenses, due to a legal requirement to check for availability of services in a country.

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. Its format is alias@domain, where domain must be present in the tenant's collection of verified domains. This is sometimes the same as the user's email address. String FALSE
User Type A string value that can be used to classify user types in your directory, such as Member and Guest. Dropdown FALSE

Output

Field Definition Type
ID Unique identifier for the user. 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 last name. String
Mail SMTP address for the user.

For example, jeff@contoso.onmicrosoft.com.

 String
Account Enabled true if the account is enabled; otherwise, false. Boolean
Age Group Age group of the user. Allowed values: null, minor, Not Adult and adult. String

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management API overview