Accounts

An Account represents a set of credentials a USP Server instance uses to validate external incoming connections, such as those from partners, customers, vendors, internal users, or other organizations exchanging files with your system.

Before You Begin

Authentication Methods

The credentials required for authentication are determined by the Inbound Authentication Method configured in the Rule associated with the Inbound Node that handles the external incoming connection.

Accounts must be configured with the appropriate credentials based on the selected authentication method. The available authentication options are:

• Password: Only password-based authentication is accepted.
• Public Key: Only SSH key-based authentication is accepted.
• Password or Public Key: Either password-based or SSH key-based authentication is accepted.
• Password and Public Key: Both password-based and SSH key-based authentication are required.

info

Refer to Rules documentation for more information.

Account Administration via USP Admin UI

Adding an Account

To add an Account, follow these steps:

1. From the Sidebar, click Configuration > Accounts.
2. Click the row of the Account Repository where you want to add the Account.
3. Go to the Accounts tab.
4. Click the Add Account button above the Accounts list.
5. Complete the Account details using the Field Descriptions table as a guide.
6. Click Save.

Field Descriptions

Name	Description	Specifications	Required
Username	The username of the Account	Must be unique.	Yes
Description	The description of the Account.		No
Password	The password of the Account.	Must follow the Password Pattern.	Yes
Public Key	The Public Key associated with this Account.	Must reference an already-created Public Key.	No

Editing an Account

To edit an Account, follow these steps:

1. From the Sidebar, click Configuration > Accounts.
2. Click the row of the Account Repository where the Account is added.
3. Go to the Accounts tab.
4. Click the row of the Account you want to edit.
5. Click the Edit button above the Account details.
6. Edit the Account details using the Field Descriptions table as a guide.
7. Click Save.

warning

If you modify an Account 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 details include all parameters given in the Field Descriptions table above, plus the following read-only metadata:

Account Metadata

Name	Description
ID	Universally Unique Identifier of this Account.
Account Repository ID	The ID of the Account Repository where this Account belongs.
Created At	Date and time this Account was created.
Updated At	Date and time this Account was last updated.

Deleting an Account

To delete an Account, follow these steps:

1. From the Sidebar, click Configuration > Accounts.
2. Click the row of the Account Repository where the Account is added.
3. Go to the Accounts tab.
4. Click the row of the Account you want to delete.
5. Click the Delete button above the Account details.
6. You will be asked to confirm the deletion. Click Delete.

warning

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

Additionally, if the Account 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.