Definition:

The "Find Organizational Unit" action in Zenphi allows you to retrieve detailed information about an organizational unit (OU) in Google Directory. An organizational unit is a way to categorize users and groups in Google Workspace based on their function, location, or any other criteria defined by the admin. This action helps you locate specific organizational units within your Google Directory based on either the organizational unit path or its unique ID.

Key capabilities of this action include:

Retrieving organizational unit details: Get information like the ID, name, parent unit, and description of any organizational unit in Google Directory.
Flexibility: The action allows searching by the full organizational unit path or its unique ID, making it easy to pinpoint specific units across different levels of hierarchy.

This action is useful for administrators who need to programmatically manage or report on the organizational structure within Google Directory, helping streamline processes like user management and permission assignment.

Example Use Cases

1. Retrieve Organizational Unit Details for User Management

An admin wants to gather information about a specific organizational unit to manage users more effectively. This action can be used to find out the details of any organizational unit, such as its name, parent, and description, which helps in assigning or modifying user roles within the correct units.

2. Report on Organizational Unit Structure

HR teams or IT admins may need to create reports on the structure of their Google Workspace account. This action allows them to retrieve a full list of organizational units, their parent-child relationships, and descriptions for auditing or reporting purposes.

3. Confirm Organizational Unit Path for Group Assignment

When assigning users to specific groups or adjusting permissions, the admin needs to verify the organizational unit path. This action helps ensure that the correct OU is selected for a user or group, preventing errors in group assignments.

4. Troubleshoot Organizational Unit Issues

If a user is not receiving the correct access or permissions, an admin may need to check if they are in the correct organizational unit. This action allows the admin to confirm the user's organizational unit path and resolve any misassignments.

5. Streamline Multi-Domain Customer Management

In a multi-domain environment, an admin may want to search across all customer units. Using the "Find Organizational Unit" action with the Customer Id, they can retrieve organizational units from different domains and ensure consistency in the structure across the organization.

Inputs

1. Connection

The Connection field refers to the authenticated link between Zenphi and your Google Directory. It ensures that Zenphi can access and interact with your Google Workspace account. You need to provide a valid connection to authenticate and authorize the action to retrieve data from Google Directory.

What it does: It authenticates the request to access your Google Workspace data.
Where to find it: You can set up and manage this connection in the Zenphi platform.

2. Organizational Unit Path

The Organizational Unit Path is the full path of the organizational unit within your Google Workspace hierarchy, excluding the leading /. It defines the specific organizational unit you want to retrieve details for. For example, if you are looking for the sales support unit under the sales department, the path could be /corp/sales/sales_support.

What it does: It tells Zenphi which specific organizational unit to retrieve details for.
Format: The path should be entered without the leading / and can be a full path to the OU or just its unique ID.
Example: For the "Sales Support" unit in the "Corp" department, you would enter: corp/sales/sales_support.

3. Customer Id

The Customer Id is a unique identifier assigned to your Google Workspace account in the Admin Console. It is necessary to specify this ID to identify the customer for which the organizational unit data is being retrieved.

What it does: It specifies which Google Workspace customer’s data is being requested.
Where to find it: You can find your Customer Id by logging into your Google Admin Console and navigating to Account settings > Profile.
Example: C00000000 (replace with your actual customer ID).

4. (Optional) SKU Id

While optional for this action, the SKU Id refers to the product SKU that the organizational unit may be associated with. It’s generally used to filter results by product type, but it’s not mandatory for retrieving organizational unit data.

What it does: It filters the results by a specific product SKU if provided.
Where to find it: You can find the SKU Id in your Google Admin Console under the licensing section or through the SKU documentation provided by Google.
Example: google-workspace-enterprise (replace with the actual SKU Id if needed).

By providing the correct inputs, the action can retrieve accurate organizational unit data based on the specified parameters.

Outputs

1. Organizational Unit Id

The Organizational Unit Id is a unique identifier assigned to the organizational unit within Google Directory. It helps to uniquely identify the organizational unit, regardless of its name or path, and is especially useful when performing API operations that require specifying a particular organizational unit.

What it does: Provides a unique identifier for the organizational unit.
Example: 12345678 (This is a sample Organizational Unit ID assigned by Google Directory).

2. Organizational Unit Path

The Organizational Unit Path shows the full path to the organizational unit in the Google Directory hierarchy. It includes the parent organizational unit(s) and the current unit, which helps in identifying where the unit exists within the broader structure.

What it does: Shows the hierarchical path to the organizational unit, making it clear where the unit sits within the organizational structure.
Example: /corp/sales/sales_support (This is a sample path to an organizational unit in the "Sales Support" department).

3. Name of Organizational Unit

The Name of Organizational Unit is the specific name of the organizational unit, which helps to identify it clearly without needing to reference the path or ID. This name is usually assigned by the admin during the creation of the organizational unit.

What it does: Provides the human-readable name of the organizational unit.
Example: Sales Support (This is the name of the organizational unit, such as a department or team within an organization).

4. Parent Organizational Unit

The Parent Organizational Unit is the organizational unit that directly oversees the current organizational unit. It is shown as a path to indicate where the unit fits within the overall hierarchy.

What it does: Identifies the parent organizational unit within the hierarchy. This allows admins to understand the broader organizational structure.
Example: /corp/sales (This is the parent organizational unit for sales_support, showing that "Sales Support" is a child of the "Sales" department).

5. Parent Organizational Unit Id

The Parent Organizational Unit Id is the unique identifier for the parent organizational unit, just as each organizational unit has its own unique ID. It is used for more technical or API-specific purposes when interacting with the Google Directory.

What it does: Provides the unique ID for the parent organizational unit, which helps in identifying the parent unit more precisely.
Example: 87654321 (This is a sample ID for the parent organizational unit).

6. Description

The Description field provides a detailed explanation of the organizational unit, which can include details such as its function, purpose, or any other notes relevant to that unit. This field is typically set during the creation of the unit and can be used for better understanding and reporting.

What it does: Provides additional information about the organizational unit, allowing administrators to understand the purpose and role of that unit within the organization.
Example: This unit handles sales operations for the North American region. (A description explaining the purpose of the Sales Support organizational unit).

Example Use Case:

Situation: Retrieving Organizational Unit Details for a Sales Department

Scenario:
Imagine a company has multiple departments organized in a hierarchical structure within Google Directory, such as "Corporate," "Sales," and "Support." The "Sales" department is further divided into smaller teams like "Sales Support" and "Sales Operations." An administrator wants to retrieve details about the "Sales Support" team within the "Sales" department.

Steps:

The administrator knows the exact path to the organizational unit they need information on: /corp/sales/sales_support.
Using the Find Organizational Unit action, they enter the Organizational Unit Path as /corp/sales/sales_support and specify the Customer Id as their unique ID (or use the my_customer alias for convenience).
The action retrieves the organizational unit details, including:
- Organizational Unit Id: A unique identifier for "Sales Support."
- Organizational Unit Path: /corp/sales/sales_support
- Name of Organizational Unit: Sales Support
- Parent Organizational Unit: /corp/sales
- Parent Organizational Unit Id: The ID for the "Sales" department.
- Description: Details about the purpose of this unit, e.g., This unit handles sales operations for the North American region.

Outcome:
The administrator now has a comprehensive view of the "Sales Support" unit's structure and description. This information can be used to ensure proper user assignments, departmental reporting, or troubleshooting organizational issues.

This action is useful when administrators need to quickly access organizational unit details to manage or report on the structure within Google Directory.