Access Controls for API Keys

Access Controls for API Keys is an Enterprise Level Feature, however Teams will be able to use this page to generate a Teams Computer Key.

Creating a New API Key

  • Navigate to the Parsec for Teams Admin Panel

2023-03-08_10.33.44_Home_Screen.png

  • Click Keys in the Left Hand Side Navigation. You will navigate to the Keys Page.

2023-03-08_10.34.08_Keys_Page.png

  • Your API Keys, Team Computer Key and SCIM Key can all be listed here. For this how-to we will focus exclusively on API Keys.
  • Click Create Key

2023-03-08_10.34.19_Create_Screen.png

  • Select Public API Key and Click Next

2023-03-08_10.34.49_Select_Public_API.png

  • Name Your Key. It is best practice to name it something descriptive.

2023-03-08_10.35.01_Name_Key.png

  • Set the Permissions for the key.

2023-03-08_10.35.13_Set_Key_Permissions_from_an_Emtpy_Set_of_Permissions.png

  • Click Generate Key

2023-03-08_10.35.45_Generate_Key.png

  • IMPORTANT: This is a key step. You will reveal the Key Secret and only have once to store this Key Secret in a safe place. If you Navigate away or hide the Secret without copying it to a safe place there is no way to recover the key secret.

2023-03-08_10.35.54_Reveal_Key_Secret.png

  • Return to Keys Page to See Summary Key Information including metadata such as Created Date, Created By, and When and Where the Key was last used.

2023-03-08_10.36.13_Return_to_Keys_Page_to_See_Summary_Key_Information.png

  • You can also click the permissions tab to review what permissions were set when the key was generated

2023-03-08_10.36.49_Review_Key_Permissions.png

Duplicating API Keys

Duplicating a key will create an exact copy of this key with the same permissions and a new key Secret. The original key will remain unchanged.

  • To begin, click Duplicate Key.

2023-03-08_10.36.50_Duplicate_Key_Button.png

  • Review draft key permissions.

2023-03-08_10.36.58_Duplicate_Key_Second_Screen.png

  • Adjust duplicate key permissions if required and click Generate Key

2023-03-08_10.37.31_Adjust_Key_Permissions.png

  • IMPORTANT: This is a key step. You will reveal the Key Secret and only have once to store this Key Secret in a safe place. If you Navigate away or hide the Secret without copying it to a safe place there is no way to recover the key secret. Reveal duplicate key secret.

2023-03-08_10.37.46_Copy_Duplicated_Key_Secret.png2023-03-08_10.37.41_Reveal_Duplicated_Key_Secret.png

Disabling and Deleting API Keys

You may disable this key to temporarily invalidate its permissions. Disabled keys can be re-enabled at any time. Deleting a key is irreversible and cannot be undone.

  • To disable an API Key, click Disable Key.

2023-03-08_10.38.09_Disable_Key_Button.png

  • View the confirmation message

2023-03-08_10.38.10_Key_Disable_Confirmation.png

  • To delete and API Key, click Delete Key. Please note you can only delete a key after it has been disabled.
  • Click Delete in the confirmation dialog box.

2023-03-08_10.38.20_Delete_Confirmation_Modal.png

  • View the confirmation message.

2023-03-08_10.38.27_Key_Deletion_Confirmation.png