Skip to main content

Account Repositories

An Account Repository is a container for organizing and managing Accounts, which store authentication credentials used by the USP Server to validate external incoming connections, such as those from partners, customers, vendors, internal users, or other organizations that exchange files with your system.

Before You Begin​

Integration with Rules​

Account Repositories integrate with Rules, allowing the USP Server to validate inbound client connections against a defined set of Accounts. This integration enables flexible, centralized management of client authentication without requiring individual credential management at each connection point.

Inbound Authentication Setup​

To configure an Account Repository (and its associated Accounts) as the authentication source for inbound connections, follow these steps:

  • In the Rule's configuration, set the Inbound Authentication Source to Account Repository.
  • Select the appropriate Account Repository from the dropdown menu.
info

For more information, refer to Rules.

Authentication Flow​

Once a Rule is configured to use an Account Repository, the following sequence occurs during an inbound connection:

  1. An Account attempts to connect to the USP Server.
  2. The incoming connection is processed by an Inbound Node.
  3. The USP Server consults the configured Account Repository to validate the credentials.
  4. If a matching Account (by username) is found, credentials are validated according to the SSH Authentication Method defined in the Rule.

Account Repository Administration via USP Admin UI​

Adding an Account Repository​

To add an Account Repository, follow these steps:

  1. From the Sidebar, click Configuration > Accounts.
  2. Click Add Account Repository.
  3. Complete the details for the new Account Repository using the Field Descriptions table as a guide.
  4. Click Save.

Field Descriptions​

NameDescriptionSpecificationsRequired
NameThe name of the Account Repository.Must be unique.Yes
DescriptionThe description of the Account Repository.No

Editing an Account Repository​

To edit an Account Repository, follow these steps:

  1. From the Sidebar, click Configuration > Accounts.
  2. Click the Name of the Account Repository you want to edit.
  3. Click the Edit button above the Account Repository details.
  4. Edit the Account Repository details using the Field Descriptions table as a guide.
  5. Click Save.
warning

If you modify an Account Repository that is currently in use by a USP Server instance, the changes will not take effect until you manually apply the updated configuration by pushing it to the server. To apply the changes:

  1. Navigate to Monitoring > Status.
  2. Click the Name of the associated USP Server instance.
  3. Go to the Configuration tab.
  4. Review the pending changes in the Updated Configuration column.
  5. If the changes are correct, click Push Configuration.

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

Account Repository Metadata​

NameDescription
IDUniversally Unique Identifier of this Account Repository.
Created AtDate and time this Account Repository was created.
Updated AtDate and time this Account Repository was last updated.

Deleting an Account Repository​

To delete an Account Repository, follow these steps:

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

USP Manager prevents deletion of an Account Repository if it is currently referenced by a Rule.

Additionally, if the Account Repository is used by a USP Server instance, the updated configuration must be manually applied. To apply the changes:

  1. Navigate to Monitoring > Status.
  2. Click the Name of the associated USP Server instance.
  3. Go to the Configuration tab.
  4. Review the pending changes in the Candidate Configuration - Preview section.
  5. If the changes are correct, click Push Configuration.

The changes do not take effect on the server until this step is completed.