Skip to main content

Credentials

You can define a Credential and use it to determine who the Job will run as. A Credential has a Display Name, Logon Username, and a password. 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 is a property on the Job 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.

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.
  • Logon Username – The actual username that is used for logging in.
  • Description – An optional summary of the Credential.
  • Last Change UTC – The date and time the Credential was added or changed.

Viewing all Credentials

  1. Click Execution from the main menu.
  2. Click Credentials. All Credentials are listed.
  3. Click a column heading to sort the list.

Adding a Credential

You can add a Credential within JAMS and set permissions as needed. However, adding an Access Control Entry (ACE) is available for only federated users. If you log in with the admin/service account, you cannot add ACEs.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click Add.
  4. In the Display Name field, enter a Credential Name. This may be the name used when logging on with these Credentials.
  5. In the Logon Username field, enter a Logon As name if the name used when logging on is different than the Credential Name.
  6. In the Password and Reenter password fields, enter a password.
  7. Click Save and Continue to Edit.
  8. Click the Security tab.
  9. Click ADD to add an Access Control Entry (ACE).
  10. Search for an ACE to add. Only user accounts within the synchronized federation will be available from the search. For example, if you logged in with an account in the mycompany.com domain, you will see only user accounts from that same domain.
  11. Click Select.
  12. To add permissions, click the down arrow for the username.
  13. Use the checkboxes to select the appropriate access permissions.
  • Change: includes permissions to edit the user account details.
  • Get Password: includes permission to obtain a clear-text password using the Get-JAMSCredential PowerShell cmdlet or via the .NET API.
  • Submit: grants the selected user account submission capabilities for a Job.
  • Control: provides the ability to edit the user account's access control entry.
  1. Click Save.

Modifying a Credential

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 Username, and Credential Description.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the name of the Credential you want to edit.
  4. On the Summary tab, you can edit the Display Name, Logon Username, or Description.
  5. On the Security tab, you can edit the Access Control Entries to modify permissions for the groups/user accounts.
  6. Click Save.

Changing the Password for a Credential

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the name of the Credential you want to edit.
  4. On the Summary tab, click Change.
  5. In the New Password and Reenter Password fields, enter the new password.
  6. Click Save.

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 Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to delete.
  4. Click Delete.
  5. When you are prompted to confirm the deletion, click Delete to confirm.

Key Management

Generating a Key

You can generate RSA or DSA keys in JAMS.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to edit.
  4. Click the Key Management tab.
  5. Click Generate Key. A dialog is displayed.
  6. In the Algorithm field, select RSA or DSA.
  7. In the Size field, select 512, 1024, 2048, or 4096. The options will vary based on the selected algorithm.
  8. Click OK.
  9. Click Save.

Clearing an Existing Key

You can clear an existing key and fingerprint from a Credential.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to edit.
  4. Click the Key Management tab.
  5. Click Clear Key.
  6. Click Save.

Importing a Private Key

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to edit.
  4. Click the Key Management tab.
  5. Click Import. A dialog is displayed.
  6. Click Browse.
  7. Go to the location where the private key is saved.
  8. Click Open.
  9. Enter the password for the private key.
  10. Click OK.

Exporting a Public Key

You can export a public key to the OpenSSH, SSH2, and SSH2 Base64 formats.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to edit.
  4. Click the Key Management tab.
  5. Click Export. A drop-down menu is displayed.
  6. Click Public Key. The Export Public Key dialog is displayed.
  7. In the Format field, select the format.
  8. Click OK. The key is exported and available in your local Downloads folder. It is saved in the following format: {credential-name}-public-key-{format}.pub

Exporting a Private Key

For private keys, you can export it with a passphrase in the Putty, OpenSSH, and PCKS #8 formats. Your Credential must have the Get Password permission to export a keypair.

  1. Click Execution from the main menu.
  2. Click Credentials.
  3. Click the Credential you want to edit.
  4. Click the Key Management tab.
  5. Click Export. A drop-down menu is displayed.
  6. Click Private Key. The Export Private Key dialog is displayed.
  7. In the Format field, select the format.
  8. In the New Password field, enter a password for the private key.
  9. In the Confirm Password field, enter the same password.
  10. Click OK. The key is exported and available in your local Downloads folder. It is saved in the following format: {credential-name}-private-key-{format}.{extension}

User Credential Tabs

Summary TabDescription
Display NameThis 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 UsernameThis property is the actual username that is used for logging in.
DescriptionThis property is an optional summary of the Credential.
PasswordThis property is the password for the Credential. You can change this password as needed.
Last Change UTCThis property is the date and time the Credential was added or changed.
Key Management TabDescription
Public KeyThe Public Key section displays the current public key for the Credential.
FingerprintThe Public Key section displays the fingerprint of private key for the Credential.
Last Change UTCThis property is the date and time the Credential was added or changed.
Security TabDescription
SecurityThe 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: includes permissions to edit the user account details.     
  • Get Password: includes permission to obtain a clear-text password using the Get-       JAMSCredential PowerShell cmdlet or via the .NET API.     
  • Submit: grants the selected user account submission capabilities for a Job.     
  • Control: provides the ability to edit the user account's access control entry.
Last Change UTCThis property is the date and time the Credential was added or changed.
References TabDescription
ReferencesThe References tab lets you view where the Credential is used within JAMS.