Working with User Credential Definitions

You can define a Credential and use it to determine who the Job will run as. A Credential has a Display Name, Logon As name, and a password or a key. You can assign a Credential to a Job or a Folder. If you want to control a group of Jobs, you can assign a Credential at the Folder level to control all Jobs within the Folder. You can override the Credential on a Job within a Folder by setting a Credential on the specific Job.

Credentials can also be used for authenticating connections to remote services, including mail servers, FTP/SFTP servers, and SQL/Oracle databases. They can also be dynamically retrieved during a script execution.

The Execute As user for a Job is a property on the Job itself (or inherited from a parent Folder). The ACL on the Credential determines which users can link a Job to use a Credential, update/delete the Credential or retrieve its password. When a Job is submitted, it will run under the username of the Credential specified in this property.

NOTE: For Sequence and Workflow Jobs, ensure the parent Job has a Credential with the appropriate permissions to run the Jobs within it.

NOTE: To modify a JAMS Credential definition, you must have the appropriate level of permissions in the ACL to assign or change a Credential's properties.

Credentials screen

The Credentials screen lets you view all existing Credentials, create new Credentials, and modify existing Credentials. Each Credential displays the following:

  • Display name – The name for the Credential that is displayed within JAMS objects, such as Jobs or folders. This does not need to match the Logon Username.
  • Description – An optional summary of the Credential.
  • Logon Username - The actual username that is used for logging in.

Viewing all Credentials

  1. Click Credentials in the Shortcuts menu. All Credentials are listed.
  2. Click a column heading to sort the list.

Adding a Credential

As a prerequisite, all JAMS Credentials must be recognized by the JAMS system before they can be assigned an access level if a domain is included in the Logon As account.

For information on public keys, see Public Key Authentication.

  1. Click Credentials in the Shortcuts menu.
  2. Click Add.
  3. In the Credential Name field, enter a Credential Name. This may be the name used when logging on with these Credentials.
  4. In the Logon As field, enter a Logon As name if the name used when logging on is different than the Credential Name.
  5. In the Enter Password and Re-Enter password fields, enter a password.
  6. Click Ok.
  7. If desired, enter a Description.
  8. Click Key Management to manage public and private keys for the JAMS Credential Security object that provides access to the remote server.
    NOTE: JAMS supports SSH public/private key pairs directly within the GUI. You can load any existing private key by selecting the Load Key button. Only private keys can be loaded. JAMS then prompts for a Privacy Enhanced Mail Certificate (.pem) file.
  9. Click Set Password to manage the Credential Definition's password.
  10. Click the Security tab.
  11. Click + to create an ACE.
  12. Click New Access Control Entry.
  13. Highlight the desired ACE (Access Control Entry) and use the checkboxes to select the appropriate access types. See the Credential Properties section below for more information.
  14. When you are finished, click Save and Close.

Applying a Credential to a Job or Folder

  1. Click Definitions in the Shortcuts menu.
  2. Right-click a Job or a Folder, and select Properties.
  3. Click the Properties tab.
  4. In the Execute As field, select the Credential to run the Job.
  5. Click Save and Close.

Modifying a Credential

NOTE: To modify a JAMS Credential definition, you must have the appropriate level of permissions in the ACL to assign or change a Credential's properties.

You can modify the Display Name, Logon As, and Credential Description.

  1. Click Credentials in the Shortcuts menu.
  2. Right-click the name of the Credential you want to edit, and select Properties.
  3. Edit the Display Name, Logon As, or Description fields.
  4. Click Save and Close.

Changing the Password for a Credential

  1. Click Credentials in the Shortcuts menu.
  2. Right-click the name of the Credential you want to edit, and select Properties.
  3. Click Set Password.
  4. In the New Password and Confirm Password fields, enter the new password.
  5. Click OK.
  6. Click Save and Close.

Deleting a Credential

Before you can delete a Credential, ensure there are no object referencing it. You can check this from the References tab on the Credential.

  1. Click Credentials in the Shortcuts menu.
  2. Click the Credential you want to delete.
  3. Click Delete.
  4. When prompted, click Yes to confirm.

Credential Properties

Username Tab

Option Description
Display Name This property is the name for the Credential displayed in JAMS objects, such as Jobs or Folders. This does not need to match the Logon Username.
Logon As This property is the actual username that is used for logging in.
Description This property is an optional summary of the Credential.
Key Management This button lets you manage public and private keys for the JAMS Credential.
Password This button lets you set the password for the Credential. You can change this password as needed.
Last Changed This property is the date and time the Credential was added or changed.

Security Tab

Option Description
Security The Security tab defines the level of access for this Credential. This is an Access Control List with one-to-many Access Control Entries (ACE). Each ACE can specify the following rights:
  • Change: users can modify the Credential if they have Change access in Credential Definitions.
  • Control: users can modify the Credential's Access Control List.
  • Submit: users can associate the Credential with Folder/Job Definitions.
  • Get Password: users can retrieve the password from the Credential Definition.

References Tab

Option Description
References The References tab lets you view where the Credential is used within JAMS.

Related Topics