Username and Password

The Username and Password credential type represents a standard authentication pair used to authenticate against external (remote) systems, LDAP directories, or any service that requires basic username/password credentials.

A Username and Password credential consists of:

• Username: The login or service identity used for authentication..
• Password: The associated password used for authentication.

info

UDMG supports several key types and verifies that each key is in the correct format when saved. These keys are Username and Password stored securely and their values are masked in the UDMG Admin UI, and can only be retrieved via the API.

Use Cases

#	Use Case	Referenced By	Purpose
1	External SFTP Server Authentication	A Pipeline with a Remote SFTP Server Endpoint	Allows UDMG to authenticate to an external (remote) SFTP server when UDMG is acting as an SFTP client. The external SFTP server requires password-based authentication..
2	LDAP Authentication	User and Account LDAP Configuration	User and Account LDAP authentication. The Username and Password contains the password for the Bind DN. The connector uses these Credentials to search for UDMG Users and Account Groups.

External SFTP Server Authentication

When UDMG is acting as an SFTP client, it can use a Username and Password credential type to authenticate with an external SFTP server that requires password-based authentication.

Implementation

1. A username and password are generated outside of UDMG (typically by the administrator of the external SFTP server) and shared with your organization.
2. A new Credential (with Type: Username and Password) is added on the Credentials page with the content from Step 1.
3. A new or existing Pipeline configuration (with Source Endpoint or Destination Endpoint set to Remote SFTP Server Endpoint) can now reference this Credential from the Credentials Name field.
4. When UDMG initiates a connection to the external SFTP server, it uses the referenced Credential to authenticate itself.

LDAP Authentication

Username and Password Credentials are also used as Bind Credentials when connecting to an LDAP server for User or Account LDAP authentication. The Username and Password stores the Bind DN Username and Password, which the connector uses to search for UDMG Users and Account Groups. The Credentials should map to your LDAP settings.

Implementation

1. A Bind DN username and password are generated outside of UDMG (typically by the LDAP administrator) and shared with your organization.
2. A new Credential (with Type: Username and Password) is added on the Credentials page with the content from Step 1.
3. A new or existing User or Account LDAP configuration can now reference this Credential from the Bind Credentials field.
4. When UDMG initiates an LDAP connection, it uses the referenced Credential.

Adding a Username and Password

To add a Username and Password, follow these steps:

1. From the Sidebar, click Configuration > Credentials.
2. Click Add Credential.
3. Select Username and Password as the Credential Type.
4. Enter an identifying Name and Description, and optionally Valid From and Valid To dates.
5. Enter or paste in the Username and Password based on the use case.
6. Click Add.

info

Each Username and Password must be properly created to be referenced by other Configuration Items.

Field Descriptions

The following table lists all fields that can be completed when adding (or editing) a Username and Password:

Name	Description	Specifications	Required
Type	Type of Credential. Select: Username and Password.	Cannot be modified after creation.	Yes
Name	The name of the Username and Password.	Must be unique. Must follow the Standard Naming Pattern. Cannot be modified after creation.	Yes
Description	The description of the Username and Password.		No
Valid From	Date when the Credential becomes valid.	Cannot be later than Valid To date.	No
Valid To	Date when the Credential becomes invalid. info UDMG does not use or check the dates provided. The dates entered are only meant to help Users keep track of expiration dates.	Cannot be earlier than Valid From date.	No
Username	The username used to log into the external SFTP server (the remote account you authenticate with as provided by the external SFTP server partner) or the Bind DN username.	Must be at least 1 character.	Yes
Password	The password to log into the external SFTP server (the remote account you authenticate with as provided by the external SFTP server partner) or Bind DN password.	Must be at least 1 character. Values are masked and encrypted after saving.	Yes

Editing a Username and Password

To edit a Username and Password, follow these steps:

1. From the Sidebar, select Configuration > Credentials.
2. Click the Credential Name you want to edit.
3. Click the Edit button above the Credentials details to edit the specific fields.
4. Edit details for the Credentials, using the Field Descriptions above as a guide.
5. Click Update.

Managing Username and Passwords

Viewing Username and Password Details

To view the details of a Username and Password, follow these steps:

1. From the Sidebar, click Configuration > Credentials.
2. Click the Name of the Username and Password you want to view. You will see a table with the Credential details.

Username and Password Metadata

Username and Password details include all parameters given in the Field Descriptions table above, plus the following read-only metadata:

Name	Description
UUID	Universally Unique Identifier of this Username and Password.
Enabled	Credentials Enabled status. If enabled, field is set to True.
Version	Version number of the latest configuration of the Credential. Every change increases the number.
Created	Date and time this Username and Password was created.
Updated	Date and time this Username and Password was last updated.

Enabling and Disabling Username and Passwords

Username and Passwords can be Enabled or Disabled to control their active status and ability to participate in file transfers. The status is defaulted to Enabled and can be changed after creation.

• Enabled (default): The Username and Password is active and available for use.
• Disabled: The Username and Password is not active and unavailable for use.

To enable or disable a Username and Password, follow these steps:

1. From the Sidebar, click Configuration > Credentials.
2. Click the Name of the Username and Password you want to enable/disable.
3. Click the Enable or Disable button above the Username and Password details, depending on the current status.

Deleting a Username and Password

To delete a Username and Password, follow these steps:

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

warning

If a Credential is currently assigned to a Configuration Item (Pipeline) or LDAP, then it cannot be deleted. You must first remove the Credential from the specific Configuration Item(s) it is assigned to, then go back to the Credentials page to delete the Credential.