Account Groups

An Account Group creates an association between one or more Accounts and one or more Pipelines. Account Groups act as the critical link between authenticated Accounts and file transfer pathways defined by Pipelines. When an Account is associated with an Account Group, it inherits access to all the Pipelines assigned to that Account Group, enabling the Account to perform the corresponding file transfers.

Account Groups serve two key functions:

• Associate Accounts with Pipelines, enabling secure file transfers when UDMG is acting in the capacity of a file transfer server.
• Associate Accounts with Account Groups either manually or automatically when integrated with a federation source (LDAP, SSO, etc.) mapping directory group membership to UDMG's Account Groups, streamlining Account management.

info

An Account cannot participate in file transfers when UDMG is acting as the file transfer server, unless it is associated with an Account Group that has at least one Pipeline assigned.

Before You Begin

Naming and Assignment Considerations

Account Groups can be structured in various ways to meet the needs of your partners (businesses, internal or external users, customers, vendors, or other organizations). For example, you might create separate Account Groups for different partner categories, each with Pipelines tailored to their specific access permissions and file transfer needs.

To ensure a scalable and manageable configuration, we recommend that you:

• Use clear and descriptive names to simplify their assignment to Accounts.
• Group Pipelines together strategically to minimize the number of Account Groups associated with each Account. This streamlines configuration and reduces administrative overhead. Since Pipelines can belong to multiple Account Groups, design each group to include the essential or baseline Pipelines required for common use cases or permission sets.

info

Only compatible Pipelines can be assigned to an Account Group, more specifically, those where UDMG acts as the file transfer server (e.g., the Source Endpoint is a Local SFTP Server). Pipelines where UDMG acts as the file transfer client (i.e.,the Source or Destination Endpoint is a Remote SFTP Server) do not require Account Groups or Account associations to initiate file transfers.

Pipelines and Account Groups Association

Each Account Group can be associated with one or more Pipelines. While there is no limit to the number of Pipelines that can be assigned, UDMG enforces validation checks to ensure configuration integrity. These checks occur at three key stages:

• When a Pipeline is created:
  Checks for Source Endpoint + Destination Endpoint + Pipeline Configuration + Virtual Path uniqueness.
• When a Pipeline is associated with an Account Group:
  Checks for Destination Endpoint + Virtual Path uniqueness across all Pipelines within an Account Group.
• When an Account is associated with an Account Group:
  Checks for Destination Endpoint + Virtual Path uniqueness across all Pipelines associated with an Account's Account Groups.

If a conflict is identified, then the Configuration Item is blocked from being created or associated, or a detailed error message is displayed.

info

Each Pipeline Destination Endpoint and Virtual Path combination must be unique within an Account Group and across all Pipelines associated with an Account.

LDAP Authentication and Account Groups

Accounts with Login Method set to LDAP are created with at least one Account Group already associated, since existing LDAP group memberships must map to a current Account Group in UDMG to be created.

When using LDAP consider that:

• The LDAP group membership name must match the UDMG Account Group name exactly for the association and Account creation to work.
• If a user in LDAP belongs to multiple recognized Account Groups, the corresponding Account in UDMG is created with all matching Account Groups associated.

info

For more details, refer to the LDAP Authentication.

Adding an Account Group

To add an Account Group, follow these steps:

1. From the Sidebar, select Configuration > Account Groups.
2. Click the Add Account Group button.
3. Complete the Name and Description details for the new Account, using the Field Descriptions table as a guide.
4. Click Add.

info

Adding an Account Group initially requires only a name. However, its functionality is defined in the next step: Assigning a Pipeline to an Account Group.

Field Descriptions

The following table describes the fields that are configured for the Account Group:

Name	Description	Specifications	Required
Name	The name of the Account Group. Should be descriptive to support easy identification when assigning to Accounts.	Must be unique. Must follow the Standard Naming Pattern.	Yes
Description	The description of the Account Group.		No

Assigning a Pipeline to an Account Group

To assign a Pipeline to an Account Group, follow these steps:

1. From the Sidebar, select Configuration > Account Groups.
2. Click the Name of the Account Group you want to assign a Pipeline to.
3. Click the Pipeline Assignments button above the Account Group details.
4. You will see two columns: the left column lists the available Pipelines, and the right column shows the Pipelines assigned to the Account Group.
5. Drag and drop the Pipeline 'Cards' as needed. Moving a Card to the right column associates that Pipeline with the Account Group.
   • Use the search bar to filter Pipelines by name.
   • Pipeline 'Cards' in the left column that conflict with those in the right column are disabled. These appear grayed out and display a warning icon.
   • You can click Cancel to discard all changes and go back to the previous screen.
   • You can click Reset to revert the columns to the original state.
6. Click Update.

warning

Pipeline 'Cards' that have a conflict with the current assigned 'Cards' are disabled (colored gray with a warning icon) and cannot be moved to the right column unless the conflict is resolved. All Pipelines associated with an Account Group must have a unique Pipeline Destination Endpoint and Virtual Path combination.

Editing an Account Group

To edit an Account Group, follow these steps:

1. From the Sidebar, select Configuration > Account Groups.
2. Click the Name of the Account Group you want to edit.
3. Click Edit button above the Account Group details.
4. Edit the details of the Account Group using the Field Descriptions table as a guide.
5. Click Update.

info

To modify the assigned Pipelines, follow Assigning a Pipeline to an Account Group steps.

Managing an Account Group

Viewing Account Group Details

To view the details of an Account Group, follow these steps:

1. From the Sidebar, select Configuration > Account Groups.
2. Click the Account Group name you want to view.
3. Additionally, you can click the Pipelines tab to see the Pipelines associated with the Account Group, and also click the Pipeline name in the card to go to that Pipeline's Overview tab.

Each card in the associated Pipelines view conveys critical information, including:

1. The source Endpoint name and type.
2. The target Endpoint name and type.
3. The UDMG file path, which is the source path if UDMG is sending files, or the destination path if UDMG is receiving files.

info

File paths are relative to the UDMG working directory, and may reflect variable names if used in the Endpoint, such as ${ACCOUNT_NAME}. They may also include the virtual folder name which is only visible to the Account in their home directory, when UDMG is the final destination.

Account Group Metadata

Account Group details include all parameters given in the Field Descriptions table, plus the following read-only metadata:

Name	Description
UUID	Universally Unique Identifier of this Account Group.
Version	Version number of the latest configuration of the Account Group.
Created	Date and time this Account Group was created.
Updated	Date and time this Account Group was last updated.

Deleting an Account Group

To delete an Account Group, follow these steps:

1. From the Sidebar, select Configuration > Account Groups.
2. Click the Name of the Account Group you want to delete.
3. Click the Delete button above the Account Group details.
4. You will be asked to confirm the deletion. Click Delete.

warning

UDMG prevents the deletion of a Configuration Item if it is currently referenced by another Configuration Item (i.e., Account). The Configuration Item must be edited or the referenced item removed before you can delete the Endpoint. Deletion cannot be undone.