Definition

The Find Group Member action allows you to retrieve detailed information about a member within a specific group in Google Directory. It provides key insights such as member ID, email, role, status, and delivery settings. This action is useful for managing group memberships, checking user roles, and automating group-related workflows. Key capabilities include fetching data on both individual users and groups, as well as handling external and internal members within a group.

Example Use Cases

1. Manage Group Roles
   Automatically retrieve and update the role of a user in a group (e.g., changing a member’s role from MEMBER to MANAGER).

2. Audit Group Membership
   Periodically check if a user is still a member of a specific group and track changes in their membership status.

3. External Member Monitoring
   Track and manage external users who are part of a group, ensuring they maintain the proper access rights.

4. Automate Email Preferences
   Retrieve and update email delivery settings for group members, ensuring all members receive the appropriate type of notifications.

5. Inactive Member Identification
   Identify inactive or suspended members in a group and flag them for review or removal from the group.

Inputs

1. Connection

   Specifies the connection to your Google Directory service.

   Explanation: Choose the Google Workspace connection that has the appropriate permissions to access and manage Google Groups.

   Best Practices: Ensure that the connection has the necessary scopes (read/write access) for retrieving group member details.

2. Group Key

   Identifies the group you want to retrieve the member’s information from.

   Explanation: This can be the group’s email address, its alias, or its unique group ID.

   Supported Formats: Email address (e.g., [email protected]), group alias, or unique group ID (e.g., abc123group).

   Best Practices: Ensure the group key is accurate to avoid errors or retrieving incorrect group data.

3. Member Key

   Specifies the member whose information you want to retrieve.

   Explanation: This can be the member’s email address (primary or alias), or their unique user or group ID.

   Supported Formats: Email address (e.g., [email protected]), alias, or unique member ID (e.g., xyz789user).

   Best Practices: Ensure the member key corresponds exactly to the group member's identifier, to avoid mismatches or errors.

Outputs

1. Id

   The unique ID of the group member.

   Explanation: This ID can be used as a reference in other API calls, such as for retrieving or modifying the member’s details.

   Example: xyz789user

2. Email

   The primary email address of the group member.

   Explanation: This email is used to identify the member within the group.

   Example: [email protected]

3. Delivery Setting

   Defines the mail delivery preferences for the group member.

   Explanation: This value determines how the member receives emails from the group. Acceptable values are:

   • ALL_MAIL (receive all emails),
   • DAILY (receive a daily digest),
   • DIGEST (receive periodic summaries),
   • DISABLED (no mail delivery),
   • NONE (no emails). Example: DAILY

4. Role

   The role of the member in the group.

   Explanation: This value indicates whether the member is an owner, manager, or regular member.

   Example: MEMBER

5. Status

   The current status of the group member.

   Explanation: This indicates whether the member is active, archived, suspended, or if the status is unknown.

   Example: ACTIVE

6. Type

   The type of group member.

   Explanation: This shows if the member is a user, external member, customer, or another group.

   Example: USER

7. Found

   Indicates whether the member was found in the specified group.

   Explanation: This is a boolean value that returns true if the member is found and false if they are not.

   Example: true

Example Scenario

Imagine a company with multiple teams using Google Groups for communication. The IT team is tasked with verifying the members of a specific group to ensure only authorized employees have access.

Scenario:

The HR department wants to confirm if a specific employee, John Doe, is a member of the "Marketing Team" group in Google Directory and retrieve his role within the group. They want to check his membership details as part of an audit.

Steps in Zenphi:

1. Input Configuration:

   • Connection: HR connects their Zenphi workflow to Google Directory using their Google Directory Connection.
   • Group Key: The group email address for the Marketing Team is used, i.e., [email protected].
   • Member Key: The member key is set to John Doe’s primary email address: [email protected].

2. Executing the Action:

   • The Zenphi workflow triggers the "Find Group Member" action to search for John Doe in the Marketing Team group.

3. Output Results:

   • The action returns the following information for John Doe:
     • Id: xyz123user
     • Email: [email protected]
     • Delivery Setting: DAILY (John receives a daily email digest)
     • Role: MEMBER (John is a regular member of the group)
     • Status: ACTIVE (John is an active member)
     • Type: USER (John is a user)
     • Found: true (John is found in the group)

4. Next Steps:

   • HR confirms John is an active member of the Marketing Team group with the correct delivery preferences and role.
   • If necessary, HR can trigger other actions or adjustments in Zenphi based on the retrieved data, such as updating membership or communication settings.

Outcome:

HR successfully verifies John Doe’s membership and role in the Marketing Team group, streamlining the employee management process in the organization.