Office 365: List Groups
Description
Office 365: List Groups step lists the groups in Office 365.
Note:
- Admin consent is required for providing application permissions.
- By default, ConsistencyLevel header is eventual and $count=true for all requests through plugin steps.
- Expand parameter is not supported with advanced queries.
Reference:
- https://learn.microsoft.com/en-us/graph/api/group-list?view=graph-rest-1.0&tabs=http
- https://learn.microsoft.com/en-us/graph/aad-advanced-queries?tabs=http
Permission:
Following permissions are required for the registered application
Permission type | Permission (from least to most privileged) |
---|---|
Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
Configurations
No. | Field Name | Description |
---|---|---|
1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
Connection: | For details about app registration, see Office 365 App Registration for Grant Type – Password Grant or Office 365 App Registration for Grant Type Refresh Token | |
2 | Grant Type | Select the type of grant from Password Grant or Refresh Token. The data type is string. This field is mandatory. Note: It is recommended to select the grant type from Refresh Token. |
3 | Tenant ID | Tenant ID of Microsoft Account. The data type is string. This field is mandatory. |
4 | Client ID | Client ID of the Application created in Microsoft Account. The data type is string. This field is mandatory. |
Client Secret: | ||
5 | Accept Value as variable/static | Leave checkbox unchecked to accept Client Secret value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Client Secret field to appear as Text box. |
6 | Client Secret | Specify the Client Secret generated in Microsoft Account. Client Secret is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Client Secret field appears as a Text box and accepts static or variable values. Else if checkbox above is disabled Client Secret field appears as a drop down to select fields from previous steps. The data type is secure string. This field is mandatory. |
7 | Username | Specify the name of the user whose email attachments are to be downloaded. |
8 | Password | Specify the password for the provided user name. |
9 | Refresh Token | Specify the refresh token required to authenticate the details. |
10 | Button: Test Connection | Test connection with Client ID and Client Secret provided. Verifies whether the connection is established or not. Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
Input Tab: | ||
Input Fields: | ||
1 | Select | Provide the select parameter to retrieve the specific properties (columns). Select parameter to return a set of properties that are different from the default set. Suppose the default set returns the 10 properties and you need only 2 then those properties should be provided in select. For example: id, displayName, description, renewedDateTime, theme. |
2 | Expand | Provide the expand parameter to expand related resources. Use the Expand parameter to include the expanded resource or collection referenced by a single relationship (navigation property) in your results. For example: 1. appRoleAssignments 2. memberOf 3. members 4. owners 5. transitiveMembers 6. transitiveMemberOf 7. extensions Note: Only one relationship can be expanded in a single request. |
3 | Search: Get Fields | Specify the search parameter to perform a full-text search that allows you to find a particular value or phrase within a set of properties. For example: 1. “displayName:Sales” 2. “mail:abc@xtsd2.onmicrosoft.com” Note: - Property key and property value, for example, “displayName:Sales” must be enclosed in double inverted commas (“”). - For more information, see https://learn.microsoft.com/en-us/graph/search-query-parameter |
5 | Filter: Get Fields | Specify filters to narrow down a set of results based on a specific set of conditions. For example: 1. startswith(displayName, ‘a’), 2. displayName eq ‘N’ Note: For more details, see https://learn.microsoft.com/en-us/graph/filter-query-parameter |
Output Tab: | ||
Output Fields: | ||
1 | Groups(JSON) | Define the output variable name in the field. Default output variable name: Groups On successful execution, it holds the output of the plugin step in JSON format. |