Skip to main content

Authentication

Managing API Keys

You can use an API key to access Parallel Works via its REST API.

Note

Please note that API keys act as an alternate means to access your account and should be treated with the same care as your login password.

Create an API Key

Navigate to your account settings (Username > Account).

Screenshot of the user clicking Account.

On the next page, click Authentication.

Screenshot of the user clicking the Authentication tab.

Click API Keys.

Screenshot of the user clicking API Keys in the Authentication tab.

Click Add API Key.

Screenshot of the user clicking the Add API Key button.

Enter a Key Name for the new API key.

If your organization permits users to select their own expiration date for API keys, use the Expiration dropdown menu to select when your key will expire. You can choose no expiration or a date in 7, 30, 60, or 90 days. Shorter expiration periods are more secure.

Click Add Key.

Screenshot of the user clicking the Add Key button.

Your new API key will be displayed on the next page. You can use the copy button to copy and save the key in a secure place. Once you refresh or navigate away from this page, you won’t be able to see the key again.

Screenshot of the Authentication tab after clicking the Add Key button.

Delete an API Key

Navigate to Account > Authentication > API Keys and click the delete icon to remove an API key from your PW account.

Screenshot of the user clicking the delete icon for an API key.

A dialog box will appear with more information about deleting your key. Click Delete API Key to confirm the deletion. The key will be removed from your account immediately.

Managing SSH Keys

You can add an SSH key to your PW account, which will allow you to log in to any active cluster from any device with that SSH key on it.

Create an SSH Key

Navigate to your account settings (Username > Account).

Screenshot of the user clicking Account.

On the next page, click Authentication.

Screenshot of the user clicking the Authentication tab.

Click SSH Keys.

Screenshot of user clicking SSH Keys in the Authentication tab.

Click Add Key.

Screenshot of the user clicking the Add SSH Key button.

Use the Key Name field to give the key a unique name. Paste your public SSH key in the Key field. Click Add Key.

Screenshot of the Authentication tab after pasting an SSH key and naming it.

You can now log in to any active cluster. Navigate to the terminal or command line on your device and enter ssh -i /path/to/ssh/private/key username@IPaddress:


parallelworks@Parallels-Macbook-Air sshtest % ssh -i ./id_rsa demo@34.135.24.147
Last failed login: Thu Mar 2 09:48:20 UTC 2023 from 60.94.197.104.bc.googleusercontent.com on ssh:notty
[demo@democluster-70 ~]$

Copy an SSH Key

In Account > Authentication > SSH Keys, click the clipboard icon to copy your SSH key to your computer's clipboard.

Screenshot of the user clicking the clipboard icon.